A

$ XCNCIP2Test#accountBlocksTestsProperty in class XCNCIP2Test
AbstractIlsAndUserActionFactoryClass in namespace KnihovnyCz\AjaxHandler

Factory for AbstractIlsAndUserAction AJAX handlers.

$ SaveInstitutionFilter#authManagerProperty in class SaveInstitutionFilter

CitacePro service

$ Sfx#authManagerProperty in class Sfx

Auth Manager

Shibboleth::authenticate() — Method in class Shibboleth

Attempt to authenticate the current user. Throws exception if login fails.

SolrPrefixHandler::addFilters() — Method in class SolrPrefixHandler

Add filters (in addition to the configured ones)

$ SolrPrefixSorted#autocompleteFieldProperty in class SolrPrefixSorted

Autocomplete field

SolrPrefixSorted::addFilters() — Method in class SolrPrefixSorted

Add filters (in addition to the configured ones)

AbstractDbAwaredRecordIdsClass in namespace KnihovnyCz\ContentBlock

Class AbstractDbAwaredRecordIds

AbstractDbAwaredRecordIdsFactoryClass in namespace KnihovnyCz\ContentBlock

Class AbstractDbAwaredRecordIdsFactory

AbstractBaseClass in namespace KnihovnyCz\Controller

Class AbstractBase

MyResearchTrait::addDetailsFromOfflineHoldings() — Method in class MyResearchTrait

Add details from offline holdings

FlashRedirect::appendFlashMessages() — Method in class FlashRedirect

Add to URL parameters with messages from flashMessenger

ShortLoans::addCancelDetails() — Method in class ShortLoans

Update ILS details with cancellation-specific information, if appropriate.

$ Resource#author_sortProperty in class Resource
Resource::assignMetadata() — Method in class Resource

Use a record driver to assign metadata to the current row. Return the current object to allow fluent interface.

$ User#auth_methodProperty in class User
User::activateLibraryCard() — Method in class User

Activate a library card for the given username

User::activateCardByPrefix() — Method in class User

Activate the user card by library prefix

InstConfigs::applyConfig() — Method in class InstConfigs

Add config on top of current one

Resource::applySort() — Method in class Resource

Apply a sort parameter to a query on the resource table.

AskLibraryClass in namespace KnihovnyCz\Form\Handler

Class AskLibrary

AlephClass in namespace KnihovnyCz\ILS\Driver

Class Aleph

$ Holdings#availabilityProperty in class Holdings

Availability status mapping

$ MapSelection#activeProperty in class MapSelection

Is map selection active?

$ SideFacetsDeferred#authManagerProperty in class SideFacetsDeferred

Auth Manager

BuyLinksTrait::attachGoogleService() — Method in class BuyLinksTrait

Attach service for Google Books

BuyLinksTrait::attachZboziService() — Method in class BuyLinksTrait

Attach service for Zboží.cz

CitaceProTrait::attachCitaceProService() — Method in class CitaceProTrait

Attach CitacePro service to record driver

ObalkyKnihTrait::attachObalkyKnihService() — Method in class ObalkyKnihTrait

Attach service for ObalkyKnih.cz

WikidataTrait::attachSparqlService() — Method in class WikidataTrait

Attach Wikidata SPARQL connector

$ SolrDefault#authManagerProperty in class SolrDefault

Auth Manager

SolrDefault::attachRecordLoader() — Method in class SolrDefault

Attach a Record Loader

SolrDefault::attachRecordFactory() — Method in class SolrDefault

Attach a Record factory

SolrDefault::attachLibraryIdMappings() — Method in class SolrDefault

Attach libary id mappings

SolrDefault::attachAuthManager() — Method in class SolrDefault

Attach auth manager

SolrLibrary::attachFacetsConfig() — Method in class SolrLibrary

Attach facets config to property

$ ZiskejBase#authManagerProperty in class ZiskejBase
RouteGenerator::addRecordRouteKnihovnyCz() — Method in class RouteGenerator

Add record route to the configuration.

RouteGenerator::addRecordRoutes() — Method in class RouteGenerator

Add record routes to the configuration.

RouteGenerator::addStaticRouteKnihovnyCz() — Method in class RouteGenerator

Add a simple static route to the configuration.

RouteGenerator::addStaticRoutes() — Method in class RouteGenerator

Add simple static routes to the configuration.

$ ParamBag#applyChildFilterProperty in class ParamBag

Is child filter enabled?

ChildDocDeduplicationListener::appendDedupRecordFields() — Method in class ChildDocDeduplicationListener

Append fields from dedup record to the selected local record. Note: the last two parameters are unused in this default method, but they may be useful for custom behavior in subclasses.

$ DeduplicationListener#authManagerProperty in class DeduplicationListener

Auth Manager

DeduplicationListener::appendDedupRecordFields() — Method in class DeduplicationListener

Append fields from dedup record to the selected local record. Note: the last two parameters are unused in this default method, but they may be useful for custom behavior in subclasses.

$ JsonFacetListener#allFacetsAreOrProperty in class JsonFacetListener

All facets are ORed

JsonFacetListener::attach() — Method in class JsonFacetListener

Attach listener to shared event manager.

JsonFacetListener::addToLocalParams() — Method in class JsonFacetListener

Add to local parameters

MultiplyingDeduplicationListener::attach() — Method in class MultiplyingDeduplicationListener

Attach listener to shared event manager.

Params::addBoostFunction() — Method in class Params

Add boost function to Solr query

Params::addJsonFacet() — Method in class Params

Add json facet to Solr query

GuzzleHttpService::addProxy() — Method in class GuzzleHttpService

Configure proxy

SearchTabs::appendStoredSettings() — Method in class SearchTabs

Append stored settings to search URL

AbstractAdminClass in namespace VuFindAdmin\Controller

VuFind Admin Controller Base

AdminControllerClass in namespace VuFindAdmin\Controller

Class controls VuFind administration.

AdminApiControllerClass in namespace VuFindApi\Controller

Admin Api Controller

AdminApiControllerFactoryClass in namespace VuFindApi\Controller

Factory for AdminApiController.

ApiControllerClass in namespace VuFindApi\Controller

API Controller

$ ApiController#apiControllersProperty in class ApiController

Array of available API controllers

ApiController::addApi() — Method in class ApiController

Add an API controller to the list of available controllers

ApiControllerFactoryClass in namespace VuFindApi\Controller

Factory for ApiController.

ApiInterfaceClass in namespace VuFindApi\Controller

Additional functionality for API controllers.

ApiTraitClass in namespace VuFindApi\Controller

Additional functionality for API controllers.

AbstractCommandClass in namespace VuFindConsole\Command\Generate

Abstract base class for generator commands.

AbstractCommandFactoryClass in namespace VuFindConsole\Command\Generate

Shared factory for generator commands.

AbstractContainerAwareCommandClass in namespace VuFindConsole\Command\Generate

Abstract base class for generator commands relying on the service container.

AbstractContainerAwareCommandFactoryClass in namespace VuFindConsole\Command\Generate

Factory for console generator commands that rely on a service container.

AbstractRouteCommandClass in namespace VuFindConsole\Command\Generate

Abstract base class for route generator commands.

AbstractRouteCommandFactoryClass in namespace VuFindConsole\Command\Generate

Shared factory for route generator commands.

AbstractThemeCommandClass in namespace VuFindConsole\Command\Generate

Abstract base class for theme resource generator commands.

AbstractCommandClass in namespace VuFindConsole\Command\Language

Abstract base class for language commands.

AbstractCommand::addLineToFile() — Method in class AbstractCommand

Add a line to a language file

AbstractCommandFactoryClass in namespace VuFindConsole\Command\Language

Shared factory for language commands.

AddUsingTemplateCommandClass in namespace VuFindConsole\Command\Language

Language command: add string using template.

CopyStringCommand::addLineToFile() — Method in class CopyStringCommand

Add a line to a language file

CopyStringCommand::applyReplaceRule() — Method in class CopyStringCommand

Apply a replacement rule, if necessary.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

AbstractCssBuilderCommandClass in namespace VuFindConsole\Command\Util

Abstract console command: build CSS with precompiler.

AbstractExpireCommandClass in namespace VuFindConsole\Command\Util

Generic base class for expiration commands.

AbstractSolrAndIlsCommandClass in namespace VuFindConsole\Command\Util

Generic base class for Solr + ILS commands.

AbstractSolrAndIlsCommandFactoryClass in namespace VuFindConsole\Command\Util

Factory for Solr + ILS commands.

AbstractSolrCommandClass in namespace VuFindConsole\Command\Util

Generic base class for Solr commands.

AbstractSolrCommandFactoryClass in namespace VuFindConsole\Command\Util

Factory for Solr commands.

GeneratorTools::applySettingToConfig() — Method in class GeneratorTools

Apply a single setting to a configuration array.

AbstractBackendClass in namespace VuFindSearch\Backend

Abstract backend.

AbstractHandlerMapClass in namespace VuFindSearch\Backend

Base class for search backend handler maps.

AbstractHandlerMap::apply() — Method in class AbstractHandlerMap

Apply query defaults, appends, invariants.

$ Backend#adaptiveBlockSizesProperty in class Backend

Adaptive block sizes for interleaved records

RecordCollection::addError() — Method in class RecordCollection

Add an error message

RecordCollection::addErrorsFromBackends() — Method in class RecordCollection

Store errors from all backends

QueryBuilder::abstractQueryToArray() — Method in class QueryBuilder

Convert an AbstractQuery object to a query string.

ApiExceptionClass in namespace VuFindSearch\Backend\EDS

EBSCO API Exception class

$ ApiException#apiErrorDetailsProperty in class ApiException

Error message details returned from the API

$ Backend#authManagerProperty in class Backend

VuFind Authentication manager

Backend::autocomplete() — Method in class Backend

Get popular terms using the autocomplete API.

$ Base#authHostProperty in class Base

Auth host

$ Base#acceptProperty in class Base

Accept header

Base::autocomplete() — Method in class Base

Execute an EdsApi autocomplete

Base::authenticate() — Method in class Base

Generate an authentication token with a valid EBSCO EDS Api account

AutocompleteCommandClass in namespace VuFindSearch\Backend\EDS\Command

Get autocomplete results from the EDS backend

QueryBuilder::abstractQueryToArray() — Method in class QueryBuilder

Convert an AbstractQuery object to a query string.

$ SearchRequestModel#actionsProperty in class SearchRequestModel

Collection of user actions to apply to current request

SearchRequestModel::addAction() — Method in class SearchRequestModel

Add a new action

SearchRequestModel::addQuery() — Method in class SearchRequestModel

Add a new query expression

SearchRequestModel::addLimiter() — Method in class SearchRequestModel

Add a new limiter

SearchRequestModel::addExpander() — Method in class SearchRequestModel

Add a new expander

SearchRequestModel::addfilter() — Method in class SearchRequestModel

Add a new facet filter

QueryBuilder::abstractQueryToString() — Method in class QueryBuilder

Convert an AbstractQuery object to a query string.

BackendException::addTag() — Method in class BackendException

Add a tag.

$ Connector#apiVersionProperty in class Connector

API version number

QueryBuilder::abstractQueryToArray() — Method in class QueryBuilder

Convert an AbstractQuery object to a query string.

QueryBuilder::abstractQueryToString() — Method in class QueryBuilder

Convert an AbstractQuery object to a query string.

QueryBuilder::abstractQueryToArray() — Method in class QueryBuilder

Convert an AbstractQuery object to a query string.

Backend::alphabeticBrowse() — Method in class Backend

Obtain information from an alphabetic browse index.

DeleteDocument::addKey() — Method in class DeleteDocument

Add unique key to delete.

DeleteDocument::addKeys() — Method in class DeleteDocument

Add array of unique keys to delete.

DeleteDocument::addQuery() — Method in class DeleteDocument

Add delete query.

UpdateDocument::addRecord() — Method in class UpdateDocument

Add record.

HandlerMap::addParameter() — Method in class HandlerMap

Add handler default, append, or invariant.

$ LuceneSyntaxHelper#allBoolsProperty in class LuceneSyntaxHelper

All boolean operators supported by the class.

QueryBuilder::abstractQueryToString() — Method in class QueryBuilder

Convert an AbstractQuery object to a query string.

QueryBuilder::abstractQueryToString() — Method in class QueryBuilder

Convert an AbstractQuery object to a query string.

AbstractBaseClass in namespace VuFindSearch\Command

Abstract base command.

AlphabeticBrowseCommandClass in namespace VuFindSearch\Command

Fetch alphabrowse data from the backend (currently only supported by Solr)

ParamBag::add() — Method in class ParamBag

Add parameter value.

AbstractQueryClass in namespace VuFindSearch\Query

Abstract base class of user query components.

QueryGroup::addQuery() — Method in class QueryGroup

Add a query to the group.

QueryGroup::addQueries() — Method in class QueryGroup

Add group queries.

AbstractRecordCollectionClass in namespace VuFindSearch\Response

Abstract record collection (implements some shared low-level functionality).

AbstractRecordCollection::add() — Method in class AbstractRecordCollection

Add a record to the collection.

RecordCollectionInterface::add() — Method in class RecordCollectionInterface

Add a record to the collection.

RecordInterface::addLabel() — Method in class RecordInterface

Add a label for the record

RecordTrait::addLabel() — Method in class RecordTrait

Add a label for the record

AuthTokenTestClass in namespace VuFindTest\Auth

Class AuthTokenTest

$ DatabaseTest#authProperty in class DatabaseTest

Object to test

AbstractHandlerMapTestClass in namespace VuFindTest\Backend

Unit tests for handler map base class.

AutocompleteCommandTestClass in namespace VuFindTest\Backend\EDS\Command

Unit tests for AutocompleteCommand.

AlphaBrowseTestClass in namespace VuFindTest\ChannelProvider

AlphaBrowse Test Class

AlphabeticBrowseCommandTestClass in namespace VuFindTest\Command

Unit tests for AlphabeticBrowseCommand.

AddUsingTemplateCommandTestClass in namespace VuFindTest\Command\Language

Language/AddUsingTemplate command test.

AbstractExpireCommandTestClass in namespace VuFindTest\Command\Util

AbstractExpireCommand test.

AutoRetryTraitClass in namespace VuFindTest\Feature

Trait introducing an annotation that can be used to auto-retry tests that may fail intermittently due to timing issues (e.g. Mink integration tests).

PathResolverTrait::addPathResolverToContainer() — Method in class PathResolverTrait

Add PathResolverFactory to a mock container

SorterTest::asortProvider() — Method in class SorterTest

Data Provider for asort tests

AlephTestClass in namespace VuFindTest\ILS\Driver

Aleph ILS driver test

AmicusTestClass in namespace VuFindTest\ILS\Driver

ILS driver test

$ XCNCIP2Test#accountBlocksTestsProperty in class XCNCIP2Test

Test definitions for getAccountBlocks tests

MinkTestCase::assertEqualsWithTimeout() — Method in class MinkTestCase

Wait for a callback to return the expected value

MinkTestCase::assertLightboxTitle() — Method in class MinkTestCase

Verify that lightbox title contains the expected value

MinkTestCase::assertLightboxWarning() — Method in class MinkTestCase

Mink support function: assert a warning message in the lightbox.

AccountActionsTestClass in namespace VuFindTest\Mink

Mink account actions test class.

AccountMenuTestClass in namespace VuFindTest\Mink

Mink account ajax menu test class.

AdvancedSearchTestClass in namespace VuFindTest\Mink

Mink test class to test advanced search.

AlphabrowseTestClass in namespace VuFindTest\Mink

Mink test class for alphabetic browse.

AuthorSearchTestClass in namespace VuFindTest\Mink

Mink author search test class.

CallnumberBrowseTest::activateAndTestLinks() — Method in class CallnumberBrowseTest

Sets callnumber_handler to true

CartTest::addCurrentPageToCart() — Method in class CartTest

Add the current page of results to the cart (using the select all bulk controls).

CartTest::addCurrentPageToCartUsingButtons() — Method in class CartTest

Add the current page of results to the cart (using the individual add buttons).

CartTest::assertVisible() — Method in class CartTest
CombinedSearchTest::assertResultsForDefaultQuery() — Method in class CombinedSearchTest

Several different methods perform the same query against different configurations of the combined feature; this support method makes a standard set of assertions against the final results.

LinkResolverTest::assertOpenUrl() — Method in class LinkResolverTest

Click an OpenURL on the page and assert the expected results.

SavedSearchesTest::assertSavedSearchList() — Method in class SavedSearchesTest

Assert that the search history contains the provided list of searches (and nothing else).

SavedSearchesTest::activateNotifications() — Method in class SavedSearchesTest

Turn on notifications and reload the page.

$ SearchFacetsTest#activeFilterSelectorProperty in class SearchFacetsTest

CSS selector for finding active filters

SearchFacetsTest::assertFilterIsStillThere() — Method in class SearchFacetsTest

Assert that the filter used by these tests is still applied.

SearchFacetsTest::assertNoFilters() — Method in class SearchFacetsTest

Assert that no filters are applied.

SearchFacetsTest::assertNoResetFiltersButton() — Method in class SearchFacetsTest

Assert that the "reset filters" button is not present.

SearchLimitTest::assertResultSize() — Method in class SearchLimitTest

Assert the page size of the current search result set.

SearchLimitTest::assertLimitControl() — Method in class SearchLimitTest

Assert the contents and selected element of the limit control.

SearchLimitTest::assertNoLimitControl() — Method in class SearchLimitTest

Assert that no limit control is present on the page.

$ UserIpReader#argsProperty in class UserIpReader

Property for storing constructor arguments for testing.

AbstractTokenRepositoryTestClass in namespace VuFindTest\OAuth2\Repository

Abstract base class for OAuth2 token repository tests.

$ AbstractTokenRepositoryTest#accessTokenTableProperty in class AbstractTokenRepositoryTest
AccessTokenRepositoryTestClass in namespace VuFindTest\OAuth2\Repository

OAuth2 AccessTokenRepository tests.

AuthCodeRepositoryTestClass in namespace VuFindTest\OAuth2\Repository

OAuth2 AuthCodeRepository tests.

AlmaTestClass in namespace VuFindTest\Resolver\Driver

Alma resolver driver test

CursorMarkIdFetcherTest::addRecordsToCollection() — Method in class CursorMarkIdFetcherTest

Add mock records to a collection and return an array of the generated IDs.

AbstractMakeTagTestClass in namespace VuFindTest\Unit

Abstract Test Class for element making helpers

AjaxHandlerTestClass in namespace VuFindTest\Unit

Base class for AjaxHandler tests.

AlphaBrowseTestClass in namespace VuFindTest\View\Helper\Root

AlphaBrowse view helper Test Class

AbstractCssPreCompilerClass in namespace VuFindTheme

Abstract base class to precompile CSS within a theme.

AbstractThemeUtilityClass in namespace VuFindTheme

Abstract base class to hold shared logic for theme utilities.

ResourceContainer::addCss() — Method in class ResourceContainer

Add a CSS file.

ResourceContainer::addJs() — Method in class ResourceContainer

Add a Javascript file.

ResourceContainer::addJsEntry() — Method in class ResourceContainer

Helper function for adding a Javascript file.

ResourceContainer::addJsStringEntry() — Method in class ResourceContainer

Helper function for adding a Javascript file which is described as string.

ResourceContainer::addJsArrayEntry() — Method in class ResourceContainer

Helper function for adding a Javascript file which is described as array.

$ ThemeInfo#allThemeInfoProperty in class ThemeInfo

Theme configuration cache

ConcatTrait::addNonce() — Method in class ConcatTrait

Add a content security policy nonce to the item

HeadScript::addNonce() — Method in class HeadScript

Add a nonce to the item

SetupThemeResources::addMetaTags() — Method in class SetupThemeResources

Add meta tags to header.

SetupThemeResources::addLinks() — Method in class SetupThemeResources

Add links to header.

SetupThemeResources::addScripts() — Method in class SetupThemeResources

Add scripts to header or footer.

Slot::append() — Method in class Slot

Add string to list of block appends.

AbstractBaseClass in namespace VuFind\AjaxHandler

Abstract base AJAX handler

AbstractIlsAndUserActionClass in namespace VuFind\AjaxHandler

Abstract base class for handlers depending on the ILS and a logged-in user.

AbstractIlsAndUserActionFactoryClass in namespace VuFind\AjaxHandler

Factory for AbstractIlsAndUserAction AJAX handlers.

AbstractRelaisActionClass in namespace VuFind\AjaxHandler

Abstract Relais Ajax Action

AbstractRelaisActionFactoryClass in namespace VuFind\AjaxHandler

Factory for AbstractRelaisAction AJAX handlers.

AbstractUserRequestActionClass in namespace VuFind\AjaxHandler

Abstract base class for fetching information about user requests.

AjaxHandlerInterfaceClass in namespace VuFind\AjaxHandler

AJAX handler interface

$ CommentRecord#accountCapabilitiesProperty in class CommentRecord

Account capabilities helper

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

AbstractBaseClass in namespace VuFind\Auth

Abstract authentication base class

AbstractBase::authenticate() — Method in class AbstractBase

Attempt to authenticate the current user. Throws exception if login fails.

AlmaDatabaseClass in namespace VuFind\Auth

Authentication class for Alma. The VuFind database and the Alma API are combined for authentication by this classe.

$ AlmaDatabase#authenticatorProperty in class AlmaDatabase

ILS Authenticator

$ AlmaDatabase#almaDriverProperty in class AlmaDatabase

Alma driver

$ AlmaDatabase#almaConfigProperty in class AlmaDatabase

Alma config

AuthTokenClass in namespace VuFind\Auth

Class AuthToken

CAS::authenticate() — Method in class CAS

Attempt to authenticate the current user. Throws exception if login fails.

ChoiceAuth::authenticate() — Method in class ChoiceAuth

Attempt to authenticate the current user. Throws exception if login fails.

Database::authenticate() — Method in class Database

Attempt to authenticate the current user. Throws exception if login fails.

Email::authenticate() — Method in class Email

Attempt to authenticate the current user. Throws exception if login fails.

$ EmailAuthenticator#authHashTableProperty in class EmailAuthenticator

Database table for authentication hashes

EmailAuthenticator::authenticate() — Method in class EmailAuthenticator

Authenticate using a hash

Facebook::authenticate() — Method in class Facebook

Attempt to authenticate the current user. Throws exception if login fails.

$ ILS#authenticatorProperty in class ILS

ILS Authenticator

ILS::authenticate() — Method in class ILS

Attempt to authenticate the current user. Throws exception if login fails.

$ ILSAuthenticator#authProperty in class ILSAuthenticator

Auth manager

LDAP::authenticate() — Method in class LDAP

Attempt to authenticate the current user. Throws exception if login fails.

$ Manager#authProperty in class Manager

Authentication modules

$ Manager#activeAuthProperty in class Manager

Currently selected authentication module

Manager::ajaxEnabled() — Method in class Manager

Is login currently allowed?

Manager::allowsUserIlsLogin() — Method in class Manager

Is the user allowed to log directly into the ILS?

MultiAuth::authenticate() — Method in class MultiAuth

Attempt to authenticate the current user. Throws exception if login fails.

MultiAuth::authUser() — Method in class MultiAuth

Do the actual work of authenticating the user (support method for authenticate()).

MultiILS::authenticate() — Method in class MultiILS

Attempt to authenticate the current user. Throws exception if login fails.

PasswordAccess::authenticate() — Method in class PasswordAccess

Attempt to authenticate the current user. Throws exception if login fails.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

SIP2::authenticate() — Method in class SIP2

Attempt to authenticate the current user. Throws exception if login fails.

$ Shibboleth#attribsToCheckProperty in class Shibboleth

This is array of attributes which $this->authenticate() method should check for.

Shibboleth::authenticate() — Method in class Shibboleth

Attempt to authenticate the current user. Throws exception if login fails.

AutocompleteInterfaceClass in namespace VuFind\Autocomplete

Autocomplete Plug-In Interface

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

Solr::addFilters() — Method in class Solr

Add filters (in addition to the configured ones)

$ SolrPrefix#autocompleteFieldProperty in class SolrPrefix

Autocomplete field

SolrPrefix::addFilters() — Method in class SolrPrefix

Add filters (in addition to the configured ones)

Importer::adjustEncoding() — Method in class Importer

Fix the character encoding of a CSV line (if necessary).

Importer::applyCallbacks() — Method in class Importer

Recursively apply callback functions to a value.

Manager::addDownloaderCache() — Method in class Manager

Create a downloader-specific file cache.

Manager::addLanguageCacheForTheme() — Method in class Manager

Create a new file cache for the given theme name if necessary. Return the name of the cache.

AbstractBaseClass in namespace VuFind\Captcha

Abstract base CAPTCHA

$ Interval#actionIntervalProperty in class Interval

Minimum action interval in seconds

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

$ Cart#activeProperty in class Cart

Is the cart currently activated?

Cart::addItem() — Method in class Cart

Add an item to the cart.

Cart::addItems() — Method in class Cart

Add an array of items to the cart.

AbstractChannelProviderClass in namespace VuFind\ChannelProvider

Abstract base class for channel providers.

AbstractILSChannelProviderClass in namespace VuFind\ChannelProvider

Abstract base class for channel providers relying on the ILS.

AbstractILSChannelProviderFactoryClass in namespace VuFind\ChannelProvider

Factory for channel providers relying on the ILS.

AlphaBrowseClass in namespace VuFind\ChannelProvider

Alphabrowse channel provider.

AlphaBrowseFactoryClass in namespace VuFind\ChannelProvider

Factory for AlphaBrowse channel provider.

$ ListItems#andTagsProperty in class ListItems

Whether to use AND operator when filtering by tag.

ListItems::addPublicLists() — Method in class ListItems

Given an array of lists, add public lists if configured to do so.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

AccountCapabilitiesClass in namespace VuFind\Config

Class to determine which account capabilities are available, based on configuration and other factors.

$ AccountCapabilities#authProperty in class AccountCapabilities

Auth manager

AccountCapabilitiesFactoryClass in namespace VuFind\Config

Account capabilities factory.

Upgrade::addWarning() — Method in class Upgrade

Add a warning message.

Upgrade::applyOldSettings() — Method in class Upgrade

Apply settings from an old configuration to a new configuration.

Relais::authenticatePatron() — Method in class Relais

Authenticate a patron

Wikipedia::alreadyRetrieved() — Method in class Wikipedia

Check if a page has already been retrieved; if it hasn't, flag it as retrieved for future reference.

AbstractBaseClass in namespace VuFind\ContentBlock

Abstract base content block.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

AbstractBaseClass in namespace VuFind\Content

Abstract base for content loader plug-ins.

AbstractCoverClass in namespace VuFind\Content

Abstract base for cover loader plug-ins.

AbstractSyndeticsClass in namespace VuFind\Content

Abstract base for Syndetics content loader plug-ins.

AbstractSyndeticsFactoryClass in namespace VuFind\Content

Generic Syndetics content plugin factory.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

$ Booksite#apiKeyProperty in class Booksite

API key for Booksite

$ Buchhandel#apiTokenProperty in class Buchhandel

API token for Buchhandel

$ LocalFile#allowedMimeTypesProperty in class LocalFile

MIME types allowed to be loaded from disk.

$ Orb#apiUserProperty in class Orb

API user for Orb

$ Orb#apiKeyProperty in class Orb

API key for Orb

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

$ Booksite#apiKeyProperty in class Booksite

API key for Booksite

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

AbstractBaseClass in namespace VuFind\Controller

VuFind controller base class (defines some methods that can be shared by other controllers).

$ AbstractBase#accessPermissionProperty in class AbstractBase

Permission that must be granted to access this module (false for no restriction, null to use configured default (which is usually the same as false)).

$ AbstractBase#accessDeniedBehaviorProperty in class AbstractBase

Behavior when access is denied (used unless overridden through permissionBehavior.ini). Valid values are 'promptLogin' and 'exception'.

AbstractBase::attachDefaultListeners() — Method in class AbstractBase

Register the default events for this controller

AbstractBaseFactoryClass in namespace VuFind\Controller

Generic controller factory.

AbstractBaseFactory::applyPermissions() — Method in class AbstractBaseFactory

Apply permission settings to the controller.

AbstractBaseWithConfigFactoryClass in namespace VuFind\Controller

Generic controller factory (with config injection).

AbstractRecordClass in namespace VuFind\Controller

VuFind Record Controller

$ AbstractRecord#allTabsProperty in class AbstractRecord

Array of available tab options

AbstractRecord::addcommentAction() — Method in class AbstractRecord

Add a comment

AbstractRecord::addtagAction() — Method in class AbstractRecord

Add a tag

AbstractRecord::ajaxtabAction() — Method in class AbstractRecord

AJAX tab action -- render a tab without surrounding context.

AbstractSearchClass in namespace VuFind\Controller

VuFind Search Controller

AbstractSearch::advancedAction() — Method in class AbstractSearch

Handle an advanced search

AbstractSolrSearchClass in namespace VuFind\Controller

AbstractSearch with Solr-specific features added.

AbstractSolrSearch::advancedAction() — Method in class AbstractSolrSearch

Handle an advanced search

AjaxControllerClass in namespace VuFind\Controller

This controller handles global AJAX functionality

AjaxControllerFactoryClass in namespace VuFind\Controller

Ajax controller factory.

AjaxResponseTraitClass in namespace VuFind\Controller

Trait to allow AJAX response generation.

$ AjaxResponseTrait#ajaxManagerProperty in class AjaxResponseTrait

AJAX Handler plugin manager

AlmaControllerClass in namespace VuFind\Controller

Alma controller, mainly for webhooks.

AlphabrowseControllerClass in namespace VuFind\Controller

AlphabrowseController Class

AlphabrowseController::addResultsToView() — Method in class AlphabrowseController

Add alphabrowse results to the view model.

AlphabrowseController::applyHighlighting() — Method in class AlphabrowseController

Apply highlighting settings to the view based on the result set.

AuthorControllerClass in namespace VuFind\Controller

Author Search Options

AuthorityControllerClass in namespace VuFind\Controller

Authority Controller

AuthorityRecordControllerClass in namespace VuFind\Controller

Authority Record Controller

BrowseController::authorAction() — Method in class BrowseController

Browse Author

CombinedController::adjustQueryForSettings() — Method in class CombinedController

Adjust the query context to reflect the current settings.

EdsController::advancedAction() — Method in class EdsController

Handle an advanced search

AlphaBrowseTraitClass in namespace VuFind\Controller\Feature

VuFind Action Feature Trait - Alphabetic browse support

$ AlphaBrowseTrait#alphabrowseBackendProperty in class AlphaBrowseTrait

The name of the backend providing alphabrowse services.

AlphaBrowseTrait::alphabeticBrowse() — Method in class AlphaBrowseTrait

Proxy Backend::alphabeticBrowse using the CallMethodCommand.

ResponseFormatterTrait::addCorsHeaders() — Method in class ResponseFormatterTrait

Add CORS headers to a response.

$ IndexController#authManagerProperty in class IndexController

Auth manager

InstallController::attachDefaultListeners() — Method in class InstallController

Register the default events for this controller

LibraryCardsController::adjustCardRedirectUrl() — Method in class LibraryCardsController

When redirecting after selecting a library card, adjust the URL to make sure it will work correctly.

$ MyResearchController#accessPermissionProperty in class MyResearchController

Permission that must be granted to access this module (false for no restriction, null to use configured default (which is usually the same as false)).

MyResearchController::accountAction() — Method in class MyResearchController

"Create account" action

MyResearchController::addAccountBlocksToFlashMessenger() — Method in class MyResearchController

Add account blocks to the flash messenger as errors.

MyResearchController::addPendingEmailChangeMessage() — Method in class MyResearchController

Add a message about any pending email change to the flash messenger

$ OAuth2Controller#authServiceProperty in class OAuth2Controller

Laminas authorization service

$ OAuth2Controller#accessTokenTableProperty in class OAuth2Controller

Access token table

OAuth2Controller::authorizeAction() — Method in class OAuth2Controller

OAuth2 authorization request action

$ OAuth2ControllerFactory#accessTokenTableProperty in class OAuth2ControllerFactory

Access token table

OAuth2ControllerFactory::addGrantTypes() — Method in class OAuth2ControllerFactory

Add grant types to the server

OaiController::authserverAction() — Method in class OaiController

Standard OAI server.

AbstractRequestBaseClass in namespace VuFind\Controller\Plugin

Action helper base class to perform request-related actions

AbstractRequestBaseFactoryClass in namespace VuFind\Controller\Plugin

Factory for controller plugins extending AbstractRequestBase.

$ Captcha#activeProperty in class Captcha

Captcha activated in config

Captcha::active() — Method in class Captcha

Return whether a specific form is set for Captcha in the config

$ DbUpgrade#adapterProperty in class DbUpgrade

Database adapter

Holds::addCancelDetails() — Method in class Holds

Update ILS details with cancellation-specific information, if appropriate.

ILLRequests::addCancelDetails() — Method in class ILLRequests

Update ILS details with cancellation-specific information, if appropriate.

$ Permission#authManagerProperty in class Permission

Auth manager

Renewals::addRenewDetails() — Method in class Renewals

Update ILS details with renewal-specific information, if appropriate.

StorageRetrievalRequests::addCancelDetails() — Method in class StorageRetrievalRequests

Update ILS details with cancellation-specific information, if appropriate.

SummonController::attachDefaultListeners() — Method in class SummonController

Register the default events for this controller

SummonController::advancedAction() — Method in class SummonController

Handle an advanced search

SummonrecordController::attachDefaultListeners() — Method in class SummonrecordController

Register the default events for this controller

UpgradeController::attachDefaultListeners() — Method in class UpgradeController

Register the default events for this controller

$ CachingProxy#allowedHostsProperty in class CachingProxy

Array of regular expressions for hosts to cache

AbstractBackgroundLayerClass in namespace VuFind\Cover\Layer

Abstract cover background layer

AbstractLayerClass in namespace VuFind\Cover\Layer

Abstract cover layer

AbstractTextLayerClass in namespace VuFind\Cover\Layer

Abstract cover text layer

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

$ Loader#apiManagerProperty in class Loader

Plugin manager for API handlers

AdapterFactoryClass in namespace VuFind\Db

Database utility class. May be used as a service or as a standard Laminas factory.

AccessTokenClass in namespace VuFind\Db\Row

Row Definition for access_token

AuthHashClass in namespace VuFind\Db\Row

Row Definition for auth_hash

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

$ Resource#authorProperty in class Resource
Resource::addTag() — Method in class Resource

Add a tag to the current resource.

Resource::addComment() — Method in class Resource

Add a comment to the current resource.

Resource::addOrUpdateRating() — Method in class Resource

Add or update user's rating for the current resource.

Resource::assignMetadata() — Method in class Resource

Use a record driver to assign metadata to the current row. Return the current object to allow fluent interface.

$ User#auth_methodProperty in class User
User::activateLibraryCard() — Method in class User

Activate a library card for the given username

UserList::addListTag() — Method in class UserList

Add a tag to the list.

AccessTokenClass in namespace VuFind\Db\Table

Table Definition for access_token

AuthHashClass in namespace VuFind\Db\Table

Table Definition for auth_hash

ExternalSession::addSessionMapping() — Method in class ExternalSession

Add a mapping between local and external session id's

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

Resource::applySort() — Method in class Resource

Apply a sort parameter to a query on the resource table.

ResourceTags::assignAnonymousTags() — Method in class ResourceTags

Assign anonymous tags to the specified user ID.

BrowZine::arrayKeyAvailable() — Method in class BrowZine

Check if an array key is available in the data and allowed by filter settings.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

$ Unpaywall#apiUrlProperty in class Unpaywall

URL to Unpaywall API

AuthClass in namespace VuFind\Exception

Authentication Exception

AuthEmailNotVerifiedClass in namespace VuFind\Exception

Unverified email address exception.

AuthInProgressClass in namespace VuFind\Exception

Authentication in Progress Exception

AuthTokenClass in namespace VuFind\Exception

Authorization Token Exception

$ Export#activeFormatsProperty in class Export

Property to cache active formats (initialized to empty array , populated later)

Entry::addDCFormat() — Method in class Entry

Add a Dublin Core format.

Feed::addOpensearchLink() — Method in class Feed

Add a link

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

AbstractConfigClass in namespace VuFind\GeoFeatures

MapTab Configuration Class

AbstractConfigFactoryClass in namespace VuFind\GeoFeatures

GeoFeatures Abstract Config Factory Class

AbstractBaseClass in namespace VuFind\Hierarchy\Driver

Hierarchy interface class.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

AbstractBaseClass in namespace VuFind\Hierarchy\TreeDataFormatter

Hierarchy Tree Data Formatter (abstract base)

AbstractBaseFactoryClass in namespace VuFind\Hierarchy\TreeDataFormatter

Class AbstractBaseFactory

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

AbstractBaseClass in namespace VuFind\Hierarchy\TreeDataSource

Hierarchy Tree Data Source (abstract base)

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

AbstractBaseClass in namespace VuFind\Hierarchy\TreeRenderer

Hierarchy Tree Renderer

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

Sorter::asort() — Method in class Sorter

Sort array by values and maintain index association

SorterInterface::asort() — Method in class SorterInterface

Sort array by values and maintain index association

LanguageInitializerTrait::addLanguageToTranslator() — Method in class LanguageInitializerTrait

Configure a translator to support the requested language.

ExtendedIni::addToPathStack() — Method in class ExtendedIni

Add additional directories to the path stack.

AbstractAPIClass in namespace VuFind\ILS\Driver

Abstract Driver for API-based ILS drivers

AbstractBaseClass in namespace VuFind\ILS\Driver

Default ILS driver base class.

AlephClass in namespace VuFind\ILS\Driver

Aleph ILS driver

$ Aleph#alephTranslatorProperty in class Aleph

Translator object

$ Aleph#admlibProperty in class Aleph

Item library

$ Aleph#available_statusesProperty in class Aleph

Statuse considered as available

$ Aleph#addressMappingsProperty in class Aleph

Mapping of z304 address elements in Aleph to getMyProfile attributes

Aleph::appendQueryString() — Method in class Aleph

Add values to an HTTP query string.

AlephFactoryClass in namespace VuFind\ILS\Driver

Factory for Aleph ILS driver.

AlephRestfulExceptionClass in namespace VuFind\ILS\Driver

ILS Exception

AlephTranslatorClass in namespace VuFind\ILS\Driver

Aleph Translator Class

AlmaClass in namespace VuFind\ILS\Driver

Alma ILS Driver

$ Alma#apiKeyProperty in class Alma

Alma API key.

AlmaFactoryClass in namespace VuFind\ILS\Driver

Alma ILS driver factory.

AmicusClass in namespace VuFind\ILS\Driver

Amicus ILS Driver

$ GeniePlus#availableStatusesProperty in class GeniePlus

Status messages indicating available items

GeniePlus::apiStatusRecordToArray() — Method in class GeniePlus

Extract holdings data from an API response. Return an array of arrays representing 852 fields (indexed by subfield code).

$ KohaILSDI#availableLocationsDefaultProperty in class KohaILSDI

Codes of locations always should be available

  • For example reference material or material not for loan
$ KohaRest#allowCancelInTransitProperty in class KohaRest

Whether to allow canceling holds in transit. Default is false.

MultiBackend::addIdPrefixes() — Method in class MultiBackend

Change local ID's to global ID's in the given array

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

$ SierraRest#apiVersionProperty in class SierraRest

Available API version

$ SierraRest#apiBaseProperty in class SierraRest

API base path

$ SierraRest#allowCancelingAvailableRequestsProperty in class SierraRest

Whether to allow canceling of available holds

SierraRest::authenticatePatron() — Method in class SierraRest

Authenticate a patron

SierraRest::authenticatePatronV5() — Method in class SierraRest

Authenticate a patron using the API version 5 endpoints

SierraRest::authenticatePatronV6() — Method in class SierraRest

Authenticate a patron using the API version 6 patrons/auth endpoint

$ VoyagerRestful#allowCancelingAvailableRequestsProperty in class VoyagerRestful

Whether it is allowed to cancel a request for an item that is available for pickup

$ XCNCIP2#agencyProperty in class XCNCIP2

Agency definitions (consortial) - Array list of consortium members

$ XCNCIP2#availableStatusesProperty in class XCNCIP2

Statuses of available items lowercased status string from CirculationStatus NCIP element

$ XCNCIP2#activeRequestStatusesProperty in class XCNCIP2

Statuses of active requests, lowercased status strings from RequestStatusType NCIP element

$ ImageLoader#allowedFileExtensionsProperty in class ImageLoader

Array containing map of allowed file extensions to mimetypes (to be extended)

Logger::argumentToString() — Method in class Logger

Convert function argument to a loggable string

LoggerFactory::addDbWriters() — Method in class LoggerFactory

Configure database writers.

LoggerFactory::addEmailWriters() — Method in class LoggerFactory

Configure email writers.

LoggerFactory::addFileWriters() — Method in class LoggerFactory

Configure File writers.

LoggerFactory::addSlackWriters() — Method in class LoggerFactory

Configure Slack writers.

LoggerFactory::addOffice365Writers() — Method in class LoggerFactory

Configure Office365 writers.

LoggerFactory::addDebugWriter() — Method in class LoggerFactory

Add the standard debug stream writer.

LoggerFactory::addWriters() — Method in class LoggerFactory

Applies an array of filters to a writer

VerbosityTrait::applyVerbosity() — Method in class VerbosityTrait

Apply verbosity setting to message.

AbstractBaseClass in namespace VuFind\MetadataVocabulary

Metadata vocabulary base class (provides results from available RecordDriver methods in a standardized form)

$ UserIpReader#allowForwardedIpsProperty in class UserIpReader

Configuration specifying allowed HTTP headers containing IPs (false for none).

$ Server#adminEmailProperty in class Server

Admin email used in "Identify" response

Server::attachDeleted() — Method in class Server

Assign necessary interface variables to display a deleted record.

Server::attachRecordHeader() — Method in class Server

Attach a record header to an XML document.

Server::attachNonDeleted() — Method in class Server

Attach a non-deleted record to an XML document.

AuthClass in namespace VuFind\OAI\Server

OAI Server class for Authority core

AccessTokenEntityClass in namespace VuFind\OAuth2\Entity

OAuth2 access token entity implementation.

AuthCodeEntityClass in namespace VuFind\OAuth2\Entity

OAuth2 authorization code entity implementation.

$ UserEntity#accessTokenTableProperty in class UserEntity

Access token table

AbstractTokenRepositoryClass in namespace VuFind\OAuth2\Repository

OAuth2 token repository base class.

AccessTokenRepositoryClass in namespace VuFind\OAuth2\Repository

OAuth2 access token repository implementation.

AuthCodeRepositoryClass in namespace VuFind\OAuth2\Repository

OAuth2 authorization code repository implementation.

$ IdentityRepository#accessTokenTableProperty in class IdentityRepository

Access token table

AbstractFacetsClass in namespace VuFind\Recommend

SideFacets Recommendations Module

AbstractResultsPassthroughClass in namespace VuFind\Recommend

Simple abstract recommendation module that simply passes the Results object through to the template.

AbstractSummonRecommendClass in namespace VuFind\Recommend

Abstract base class for pulling Summon-specific recommendations.

AbstractSummonRecommendDeferredClass in namespace VuFind\Recommend

Abstract base for deferred-load Summon recommendations modules

AlphaBrowseLinkClass in namespace VuFind\Recommend

AlphaBrowseLink Recommendations Module

AuthorFacetsClass in namespace VuFind\Recommend

AuthorFacets Recommendations Module

AuthorInfoClass in namespace VuFind\Recommend

AuthorInfo Recommendations Module

AuthorInfoFactoryClass in namespace VuFind\Recommend

AuthorInfo recommendation module factory.

AuthorityRecommendClass in namespace VuFind\Recommend

AuthorityRecommend Module

AuthorityRecommend::addUseForHeadings() — Method in class AuthorityRecommend

Add main headings from records that match search terms on use_for/see_also.

AuthorityRecommend::addSeeAlsoReferences() — Method in class AuthorityRecommend

Add "see also" headings from records that match search terms on main heading.

$ DPLATerms#apiKeyProperty in class DPLATerms
Config
$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

$ RemoveFilters#activeFacetsCountProperty in class RemoveFilters

Search handler to try

$ SwitchType#activeProperty in class SwitchType

Is this module active?

AbstractBaseClass in namespace VuFind\RecordDriver

Abstract base record model.

AbstractBase::addTags() — Method in class AbstractBase

Add tags to the record.

AbstractBase::addOrUpdateRating() — Method in class AbstractBase

Add or update user's rating for the record.

AbstractBaseFactoryClass in namespace VuFind\RecordDriver

Default factory for record drivers.

IlsAwareTrait::attachILS() — Method in class IlsAwareTrait

Attach an ILS connection and related logic to the driver

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

SolrDefault::attachSearchService() — Method in class SolrDefault

Attach a Search Results Plugin Manager connection and related logic to the driver

AbstractBaseClass in namespace VuFind\RecordTab

Record tab abstract base class

$ AbstractBase#accessPermissionProperty in class AbstractBase

Permission that must be granted to access this module (null for no restriction)

AbstractContentClass in namespace VuFind\RecordTab

Reviews tab

AbstractContentFactoryClass in namespace VuFind\RecordTab

Abstract factory for building AbstractContent tabs.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

$ Preview#activeProperty in class Preview

Is this tab active?

AbstractFallbackLoaderClass in namespace VuFind\Record\FallbackLoader

Abstract base class for fallback loaders

AbstractFallbackLoaderFactoryClass in namespace VuFind\Record\FallbackLoader

Abstract record fallback loader factory

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

AbstractBaseClass in namespace VuFind\Resolver\Driver

AbstractBase for Resolver Driver

AbstractBaseFactoryClass in namespace VuFind\Resolver\Driver

Generic factory suitable for most resolver drivers.

AlmaClass in namespace VuFind\Resolver\Driver

Alma Link Resolver Driver

AlmaFactoryClass in namespace VuFind\Resolver\Driver

Factory for Alma resolver driver.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

DynamicRoleProviderFactory::addLegacySettings() — Method in class DynamicRoleProviderFactory

Map legacy VuFind settings into the permissions.ini setup.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

$ ServerParam#aliasesProperty in class ServerParam

Aliases for server param names (default: none)

$ User#authProperty in class User

Authorization object

$ Username#authProperty in class Username

Authorization object

RouteGenerator::addDynamicRoute() — Method in class RouteGenerator

Add a dynamic route to the configuration.

RouteGenerator::addDynamicRoutes() — Method in class RouteGenerator

Add dynamic routes to the configuration.

RouteGenerator::addNonTabRecordAction() — Method in class RouteGenerator

Add non tab record action & re-register all record routes to support it.

RouteGenerator::addNonTabRecordActions() — Method in class RouteGenerator

Add non tab record actions & re-register all record routes to support it.

RouteGenerator::addRecordRoute() — Method in class RouteGenerator

Add record route to the configuration.

RouteGenerator::addRecordRoutes() — Method in class RouteGenerator

Add record routes to the configuration.

RouteGenerator::addStaticRoute() — Method in class RouteGenerator

Add a simple static route to the configuration.

RouteGenerator::addStaticRoutes() — Method in class RouteGenerator

Add simple static routes to the configuration.

AbstractBaseClass in namespace VuFind\SMS

Base class to enable sharing of common methods between SMS subclasses

BackendManager::attachShared() — Method in class BackendManager

Attach to shared event manager.

$ BackendRegistry#aliasesProperty in class BackendRegistry

Default plugin aliases.

HideFacetValueListener::attach() — Method in class HideFacetValueListener

Attach listener to shared event manager.

$ Options#advancedHandlersProperty in class Options

Advanced search handlers

$ Options#autocompleteEnabledProperty in class Options

Autocomplete setting

$ Options#autocompleteAutoSubmitProperty in class Options

Autocomplete auto submit setting

Options::autocompleteEnabled() — Method in class Options

Is autocomplete enabled?

Options::autocompleteAutoSubmit() — Method in class Options

Should autocomplete auto submit?

Params::addFilter() — Method in class Params

Take a filter string and add it into the protected array checking for duplicates.

Params::addFacet() — Method in class Params

Add a field to facet on.

Params::addCheckboxFacet() — Method in class Params

Add a checkbox facet. When the checkbox is checked, the specified filter will be applied to the search. When the checkbox is not checked, no filter will be applied.

Params::addHiddenFilter() — Method in class Params

Take a filter string and add it into the protected hidden filters array checking for duplicates.

Params::addHiddenFilterForField() — Method in class Params

Take a filter string and add it into the protected hidden filters array checking for duplicates.

Params::addFilter() — Method in class Params

Take a filter string and add it into the protected array checking for duplicates.

Params::addHiddenFilter() — Method in class Params

Take a filter string and add it into the protected hidden filters array checking for duplicates.

Params::addFacet() — Method in class Params

Add a field to facet on.

Params::addCheckboxFacet() — Method in class Params

Add a checkbox facet. When the checkbox is checked, the specified filter will be applied to the search. When the checkbox is not checked, no filter will be applied.

Params::addDefaultFilters() — Method in class Params

Add default filters to the given params

Params::addLowerLevelHierarchicalFilterValues() — Method in class Params

Handle any lower level mappings when translating hierarchical facets.

$ Options#advancedLimitersProperty in class Options

Limiters enabled on advanced search screen (empty for all available)

$ Options#apiInfoProperty in class Options

Available Search Options from the API or null if not yet initialized

$ Options#apiInfoCallbackProperty in class Options

Callback to get available Search Options from the API

$ Options#apiOptionsInitializedProperty in class Options

Whether settings based on API info have been initialized

Params::addFacet() — Method in class Params

Add a field to facet on.

Params::addLimitersAsCheckboxFacets() — Method in class Params

Populate common limiters as checkbox facets

Params::addExpandersAsCheckboxFacets() — Method in class Params

Populate expanders as checkbox facets

Params::augmentCheckboxFacets() — Method in class Params

Augment checkbox facets with limiters and expanders retrieved from the API info

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

AbstractBackendFactoryClass in namespace VuFind\Search\Factory

Abstract factory for backends.

AbstractSolrBackendFactoryClass in namespace VuFind\Search\Factory

Abstract factory for SOLR backends.

BlenderBackendFactory::attachEvents() — Method in class BlenderBackendFactory

Create Blender listeners.

$ EdsBackendFactory#accountDataProperty in class EdsBackendFactory

EDS Account data

UrlQueryHelperFactory::addDefaultsToConfig() — Method in class UrlQueryHelperFactory

Load default settings into the user-provided configuration.

$ Memory#activeProperty in class Memory

Is memory currently active? (i.e. will we save new URLs?)

Params::addHiddenFilter() — Method in class Params

Take a filter string and add it into the protected hidden filters array checking for duplicates.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

InjectOnCampusListener::attach() — Method in class InjectOnCampusListener

Attach listener to shared event manager.

$ Options#advancedOperatorsProperty in class Options

Advanced search operators

PrimoPermissionHandler::autodetectCode() — Method in class PrimoPermissionHandler

Autodetects the permissions by configuration file

RecommendListener::attach() — Method in class RecommendListener

Attach listener to shared event manager.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

AbstractErrorListenerClass in namespace VuFind\Search\Solr

Abstract base class of SOLR error listeners.

AbstractErrorListener::addBackend() — Method in class AbstractErrorListener

Add backend to listen for.

AbstractErrorListener::attach() — Method in class AbstractErrorListener

Attach listener to shared event manager.

CustomFilterListener::attach() — Method in class CustomFilterListener

Attach listener to shared event manager.

DeduplicationListener::attach() — Method in class DeduplicationListener

Attach listener to shared event manager.

DeduplicationListener::appendDedupRecordFields() — Method in class DeduplicationListener

Append fields from dedup record to the selected local record. Note: the last two parameters are unused in this default method, but they may be useful for custom behavior in subclasses.

DefaultParametersListener::attach() — Method in class DefaultParametersListener

Attach listener to shared event manager.

FilterFieldConversionListener::attach() — Method in class FilterFieldConversionListener

Attach listener to shared event manager.

HierarchicalFacetListener::attach() — Method in class HierarchicalFacetListener

Attach listener to shared event manager.

InjectConditionalFilterListener::attach() — Method in class InjectConditionalFilterListener

Attach listener to shared event manager.

InjectConditionalFilterListener::addConditionalFilter() — Method in class InjectConditionalFilterListener

Add a conditional filter.

$ InjectHighlightingListener#activeProperty in class InjectHighlightingListener

Is highlighting active?

InjectHighlightingListener::attach() — Method in class InjectHighlightingListener

Attach listener to shared event manager.

$ InjectSpellingListener#activeProperty in class InjectSpellingListener

Is spelling active?

InjectSpellingListener::attach() — Method in class InjectSpellingListener

Attach listener to shared event manager.

InjectSpellingListener::aggregateSpellcheck() — Method in class InjectSpellingListener

Submit requests for more spelling suggestions.

MultiIndexListener::attach() — Method in class MultiIndexListener

Attach listener to shared event manager.

ErrorListener::analyzeJsonErrorResponse() — Method in class ErrorListener

Analyze JSON-encoded error response and return appropriate tags.

Params::addFacet() — Method in class Params

Add a field to facet on.

UrlQueryHelper::addFacet() — Method in class UrlQueryHelper

Add a facet to the parameters.

UrlQueryHelper::addFilter() — Method in class UrlQueryHelper

Add a filter to the parameters.

UrlQueryHelper::asHiddenFields() — Method in class UrlQueryHelper

Turn the current GET parameters into a set of hidden form fields.

AbstractPluginFactoryClass in namespace VuFind\ServiceManager

VuFind Abstract Plugin Factory

AbstractPluginManagerClass in namespace VuFind\ServiceManager

VuFind Plugin Manager

AbstractPluginManagerFactoryClass in namespace VuFind\ServiceManager

VuFind Plugin Manager factory.

AbstractBaseClass in namespace VuFind\Session

Base class for session handling

AbstractBaseFactoryClass in namespace VuFind\Session

Generic factory for instantiating session handlers

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

SimpleXML::appendElement() — Method in class SimpleXML

Attach $child to $parent.

AbstractFileClass in namespace VuFind\Sitemap

Abstract class for representing XML sitemaps

AbstractFile::addUrl() — Method in class AbstractFile

Add a URL to the map.

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

AbstractGeneratorPluginClass in namespace VuFind\Sitemap\Plugin

Base class for sitemap generator plugins

AbstractIdFetcherClass in namespace VuFind\Sitemap\Plugin\Index

Abstract helper to get IDs for a sitemap from a backend (if supported).

$ Sitemap#alternativeLanguagesProperty in class Sitemap

Alternative languages

$ PluginManager#aliasesProperty in class PluginManager

Default plugin aliases.

AbstractLayoutClassClass in namespace VuFind\View\Helper

Helper class for managing high-level (body vs. sidebar) page layout.

AbstractSearchClass in namespace VuFind\View\Helper

Helper class for displaying search-related HTML chunks.

AbstractJsStringsClass in namespace VuFind\View\Helper\Root

AbstractJsStrings helper for passing transformed text to Javascript

AbstractJsStrings::addStrings() — Method in class AbstractJsStrings

Add strings to the internal array.

AccountCapabilitiesClass in namespace VuFind\View\Helper\Root

AccountCapabilities view helper

AccountCapabilitiesFactoryClass in namespace VuFind\View\Helper\Root

AccountCapabilities helper factory.

AddEllipsisClass in namespace VuFind\View\Helper\Root

"Add ellipsis" view helper

AddThisClass in namespace VuFind\View\Helper\Root

AddThis view helper

AddThisFactoryClass in namespace VuFind\View\Helper\Root

AddThis helper factory.

AlphaBrowseClass in namespace VuFind\View\Helper\Root

Authentication view helper

AlphaBrowseFactoryClass in namespace VuFind\View\Helper\Root

AlphaBrowse helper factory.

AuthClass in namespace VuFind\View\Helper\Root

Authentication view helper

AuthFactoryClass in namespace VuFind\View\Helper\Root

Auth helper factory.

Captcha::active() — Method in class Captcha

Return whether Captcha is active in the config

Citation::abbreviateName() — Method in class Citation

Abbreviate a first name.

Config::ajaxCoversEnabled() — Method in class Config

Should be covers loaded via AJAX?

Config::alwaysDisplayIndexRecordInStaffView() — Method in class Config

Check if index record should always be displayed (i.e. also when a format-specific template is available)

Context::apply() — Method in class Context

Set an array of variables in the view; return the previous values of those variables so they can be restored.

$ Doi#areaProperty in class Doi

OpenURL context ('results', 'record' or 'holdings')

$ OpenUrl#areaProperty in class OpenUrl

OpenURL context ('results', 'record' or 'holdings')

OpenUrl::addImageBasedParams() — Method in class OpenUrl

Support method for renderTemplate() -- process image based parameters.

Permission::allowDisplay() — Method in class Permission

Determine if a local block inside the template should be displayed

RecordDataFormatter::allowValue() — Method in class RecordDataFormatter

Should we allow a value? (Always accepts non-empty values; for empty values, allows zero when configured to do so).

ResultFeed::addEntry() — Method in class ResultFeed

Support method to turn a record driver object into an RSS entry.

$ SearchBox#alphabrowseConfigProperty in class SearchBox

Alphabrowse settings for search box.

SearchBox::autocompleteEnabled() — Method in class SearchBox

Is autocomplete enabled for the current context?

SearchBox::autocompleteAutoSubmit() — Method in class SearchBox

Is autocomplete enabled for the current context?

SearchBox::alphaBrowseOptionsEnabled() — Method in class SearchBox

Are alphabrowse options configured to display in the search options drop-down?

Url::addQueryParameters() — Method in class Url

Get URL with current GET parameters and add one

VuFindSitemap::arrayToSolrXml() — Method in class VuFindSitemap

Convert an associative array of fields into a Solr document.

B

$ PageLocator#baseUrlProperty in class PageLocator

Base URL for getting pages from repository available through HTTP

$ AskLibrary#baseUrlProperty in class AskLibrary

API URL

$ InvolvedLibrariesParser#blockProperty in class InvolvedLibrariesParser
Block
InvolvedLibrariesParser::blockStartParser() — Method in class InvolvedLibrariesParser

Create BlockStartParser

$ MapSelection#boostProperty in class MapSelection

Boost query

BibframeTraitClass in namespace KnihovnyCz\RecordDriver\Feature

Trait BibframeTrait

BuyLinksTraitClass in namespace KnihovnyCz\RecordDriver\Feature

Trait BuyLinksTrait

BuyClass in namespace KnihovnyCz\RecordTab

Class Buy

$ PerformanceLogger#baseUrlProperty in class PerformanceLogger
Request
$ JsonFacetListener#backendProperty in class JsonFacetListener
Backend.
$ MultiplyingDeduplicationListener#backendProperty in class MultiplyingDeduplicationListener
Backend.
$ Params#boostFunctionsProperty in class Params

Array of functions for boosting the query

BaseFormatterClass in namespace VuFindApi\Formatter

Base formatter for API responses

FacetFormatter::buildFacetFilters() — Method in class FacetFormatter

Build an array of facet filters from the request params

FacetFormatter::buildFacetValues() — Method in class FacetFormatter

Recursive function to create a facet value list for a single facet

$ InstallCommand#baseDirProperty in class InstallCommand

Base directory of VuFind installation.

$ InstallCommand#basePathProperty in class InstallCommand

Base path for VuFind URLs.

InstallCommand::buildApacheConfig() — Method in class InstallCommand

Generate the Apache configuration. Returns true on success, error message otherwise.

InstallCommand::buildWindowsConfig() — Method in class InstallCommand

Build the Windows-specific startup configuration. Returns true on success, error message otherwise.

InstallCommand::buildImportConfig() — Method in class InstallCommand

Configure a SolrMarc properties file. Returns true on success, error message otherwise.

InstallCommand::buildDirs() — Method in class InstallCommand

Build a set of directories.

InstallCommand::buildModules() — Method in class InstallCommand

Make sure all modules exist (and create them if they do not). Returns true on success, error message otherwise.

InstallCommand::buildModule() — Method in class InstallCommand

Build the module for storing local code changes. Returns true on success, error message otherwise.

NotifyCommand::buildEmail() — Method in class NotifyCommand

Build the email message.

IndexReservesCommand::buildReservesIndex() — Method in class IndexReservesCommand

Build the reserves index from date returned by the ILS driver, specifically: getInstructors, getDepartments, getCourses, findReserves

GeneratorTools::backUpFile() — Method in class GeneratorTools

Create a backup of a file.

BackendInterfaceClass in namespace VuFindSearch\Backend

Search backend interface definition.

BackendClass in namespace VuFindSearch\Backend\Blender

Blender backend.

$ Backend#backendsProperty in class Backend

Actual backends

$ Backend#blendLimitProperty in class Backend

Limit for number of records to blend

$ Backend#blockSizeProperty in class Backend

Block size for interleaved records

BackendClass in namespace VuFindSearch\Backend\BrowZine

BrowZine backend.

$ Connector#baseProperty in class Connector

The base URI for API requests

QueryBuilder::build() — Method in class QueryBuilder

Return BrowZine search parameters based on a user query and params.

BackendClass in namespace VuFindSearch\Backend\EDS

EDS API Backend

BaseClass in namespace VuFindSearch\Backend\EDS

EBSCO Search API abstract base class

QueryBuilder::build() — Method in class QueryBuilder

Construct EdsApi search parameters based on a user query and params.

BackendClass in namespace VuFindSearch\Backend\EIT

EIT backend.

$ Connector#baseProperty in class Connector

Base url for searches

QueryBuilder::build() — Method in class QueryBuilder

Return EIT search parameters based on a user query and params.

BackendExceptionClass in namespace VuFindSearch\Backend\Exception
BackendException.
BackendClass in namespace VuFindSearch\Backend\LibGuides

LibGuides backend.

QueryBuilder::build() — Method in class QueryBuilder

Return LibGuides search parameters based on a user query and params.

BackendClass in namespace VuFindSearch\Backend\Pazpar2

Pazpar2 backend.

$ Connector#baseProperty in class Connector

Base url for searches

Connector::bytarget() — Method in class Connector

Returns information about the status of each active client.

QueryBuilder::build() — Method in class QueryBuilder

Return Pazpar2 search parameters based on a user query and params.

BackendClass in namespace VuFindSearch\Backend\Primo

Primo Central backend.

QueryBuilder::build() — Method in class QueryBuilder

Return Primo search parameters based on a user query and params.

BackendClass in namespace VuFindSearch\Backend\Solr

SOLR backend.

QueryBuilder::build() — Method in class QueryBuilder

Return SOLR search parameters based on a user query and params.

QueryBuilderInterface::build() — Method in class QueryBuilderInterface

Build SOLR query based on VuFind query object.

$ SearchHandler#booleanOperatorsProperty in class SearchHandler

Known boolean operators.

SimilarBuilder::build() — Method in class SimilarBuilder

Return SOLR search parameters based on a record Id and params.

SimilarBuilderInterface::build() — Method in class SimilarBuilderInterface

Build SOLR query based on VuFind query object.

BackendClass in namespace VuFindSearch\Backend\Summon

Summon backend.

BackendTestClass in namespace VuFindSearch\Backend\Summon

Unit tests for Summon Backend class.

QueryBuilder::build() — Method in class QueryBuilder

Return Summon search parameters based on a user query and params.

BackendClass in namespace VuFindSearch\Backend\WorldCat

WorldCat backend.

QueryBuilder::build() — Method in class QueryBuilder

Return WorldCat search parameters based on a user query and params.

$ AbstractBase#backendIdProperty in class AbstractBase

Search backend identifier

$ Service#backendsProperty in class Service

Cache resolved backends.

BackendTestClass in namespace VuFindTest\Backend\Blender

Unit tests for Blender backend.

BackendTestClass in namespace VuFindTest\Backend\BrowZine

Unit tests for BrowZine backend.

BackendTestClass in namespace VuFindTest\Backend\EDS

Unit tests for EDS backend.

BackendTestClass in namespace VuFindTest\Backend\EIT

Unit tests for EIT backend.

BackendTestClass in namespace VuFindTest\Backend\LibGuides

Unit tests for LibGuides backend.

BackendTestClass in namespace VuFindTest\Backend\Pazpar2

Unit tests for Pazpar2 backend.

BackendTestClass in namespace VuFindTest\Backend\Primo

Unit tests for Primo backend.

BackendMockClass in namespace VuFindTest\Backend\Solr
BackendTestClass in namespace VuFindTest\Backend\Solr

Unit tests for SOLR backend.

BackendTestClass in namespace VuFindTest\Backend\WorldCat

Unit tests for WorldCat backend.

MockContainer::build() — Method in class MockContainer

Alias for createMock(), needed to conform to ServiceLocatorInterface.

BokinfoTestClass in namespace VuFindTest\Content\Covers

Unit tests for Bokinfo cover loader.

BooksiteTestClass in namespace VuFindTest\Content\Covers

Unit tests for Booksite cover loader.

BuchhandelTestClass in namespace VuFindTest\Content\Covers

Unit tests for Buchhandel cover loader.

Base62TestClass in namespace VuFindTest\Crypt

Base62 Test Class

BrowZineTestClass in namespace VuFindTest\DoiLinker

BrowZine Test Class

$ SierraRestTest#bibIdsProperty in class SierraRestTest

Test bib IDs (raw value => formatted value)

BEPressTestClass in namespace VuFindTest\MetadataVocabulary

BEPress Test Class

BasicTestClass in namespace VuFindTest\Mink

Very simple Mink test class.

BlendedSearchTestClass in namespace VuFindTest\Mink

Mink test class for blended search.

BulkTestClass in namespace VuFindTest\Mink

Mink bulk action test class.

BookplateTestClass in namespace VuFindTest\Related

Bookplate Related Items Test Class

$ SearchServiceTest#backendProperty in class SearchServiceTest

Mock backend

BackendManagerTestClass in namespace VuFindTest\Search

BackendManager unit tests.

$ ParamsTest#blenderConfigProperty in class ParamsTest

Blender configuration

$ OnCampusListenerTest#backendProperty in class OnCampusListenerTest
Backend.
$ PrimoPermissionHandlerTest#backendProperty in class PrimoPermissionHandlerTest
Backend.
$ ConditionalFilterListenerTest#backendProperty in class ConditionalFilterListenerTest
Backend.
$ MultiIndexListenerTest#backendProperty in class MultiIndexListenerTest
Backend.
$ CursorMarkIdFetcherTest#backendIdProperty in class CursorMarkIdFetcherTest

Backend ID to use in tests

HoldingsTest::barcodeVisibilityBehaviorProvider() — Method in class HoldingsTest

Data provider for testBarcodeVisibilityBehavior()

$ AbstractCssPreCompiler#basePathProperty in class AbstractCssPreCompiler

Base path of VuFind.

$ ThemeInfo#baseDirProperty in class ThemeInfo

Base directory for theme files

$ Slot#blockPrependsProperty in class Slot

Storage for strings to be concatinated to the front of a block

$ Slot#blocksProperty in class Slot

Storage for strings saved to slots

$ Slot#blockAppendsProperty in class Slot

Storage for strings to be concatinated to the end of a block

Slot::build() — Method in class Slot

Helper function to return blocks with prepends and appends.

LDAP::bindForSearch() — Method in class LDAP

If configured, bind an administrative user in order to perform a search

BootstrapperClass in namespace VuFind

VuFind Bootstrapper

Bootstrapper::bootstrap() — Method in class Bootstrapper

Bootstrap all necessary resources.

$ ImporterConfig#batchSizeProperty in class ImporterConfig

Batch size

$ AlphaBrowse#browseIndexProperty in class AlphaBrowse

Browse index to search

AlphaBrowse::buildChannelFromRecord() — Method in class AlphaBrowse

Add a new filter to an existing search results object to populate a channel.

Facets::buildChannel() — Method in class Facets

Add a new filter to an existing search results object to populate a channel.

Facets::buildChannelFromToken() — Method in class Facets

Call buildChannel using data from a token.

Facets::buildChannelFromFacet() — Method in class Facets

Call buildChannel using data from facet results.

ListItems::buildListChannels() — Method in class ListItems

Build all of the channel data.

Random::buildChannelFromParams() — Method in class Random

Add a new filter to an existing search results object to populate a channel.

SimilarItems::buildChannelFromRecord() — Method in class SimilarItems

Add a new filter to an existing search results object to populate a channel.

$ PathResolver#baseDirectorySpecProperty in class PathResolver

Base directory

PathResolver::buildPath() — Method in class PathResolver

Build a complete file path from a directory specification, optional configuration file sub-directory and a filename.

Writer::buildContentValue() — Method in class Writer

Support method for buildContent -- format a value

Writer::buildContentLine() — Method in class Writer

Support method for buildContent -- format a line

Writer::buildContentArrayLines() — Method in class Writer

Support method for buildContent -- format an array into lines

Writer::buildContent() — Method in class Writer

Write an ini file, adapted from http://php.net/manual/function.parse-ini-file.php

Oracle::bindParam() — Method in class Oracle

Wrapper around oci_bind_by_name.

BlockLoaderClass in namespace VuFind\ContentBlock

Content block plugin manager

$ BlockLoader#blockManagerProperty in class BlockLoader

Block manager.

BlockLoaderFactoryClass in namespace VuFind\ContentBlock

BlockLoader factory.

BokinfoClass in namespace VuFind\Content\Covers

Plugin for Bokinfo coverimages

BooksiteClass in namespace VuFind\Content\Covers

Booksite cover content loader.

BooksiteFactoryClass in namespace VuFind\Content\Covers

Booksite cover loader factory

BrowZineClass in namespace VuFind\Content\Covers

BrowZine cover content loader.

BrowZineFactoryClass in namespace VuFind\Content\Covers

BrowZine cover loader factory

BuchhandelClass in namespace VuFind\Content\Covers

Buchhandel cover content loader.

BuchhandelFactoryClass in namespace VuFind\Content\Covers

Buchhandel cover loader factory

$ ContentCafe#baseURLProperty in class ContentCafe

Base URL

$ ObalkyKnihService#baseUrlsProperty in class ObalkyKnihService

Available base URLs

BooksiteClass in namespace VuFind\Content\Reviews

Booksite review content loader.

BooksiteFactoryClass in namespace VuFind\Content\Reviews

Booksite review plugin factory.

$ AbstractRecord#backgroundTabsProperty in class AbstractRecord

Array of background tabs

BrowZineControllerClass in namespace VuFind\Controller

BrowZine Controller

BrowseControllerClass in namespace VuFind\Controller

BrowseController Class

BrowseController::buildBrowseOptions() — Method in class BrowseController

Given a list of active options, format them into details for the view.

BrowseController::buildBrowseOption() — Method in class BrowseController

Build an array containing options describing a top-level Browse option.

CollectionsController::bytitleAction() — Method in class CollectionsController

Search by title action

SearchController::blendedAction() — Method in class SearchController

Blended search action.

$ Loader#baseDirProperty in class Loader

Directory to store downloaded images

Base62Class in namespace VuFind\Crypt

Base62 generator

BrowZineClass in namespace VuFind\DoiLinker

BrowZine DOI linker

BrowZineFactoryClass in namespace VuFind\DoiLinker

BrowZine DOI linker factory

BadConfigClass in namespace VuFind\Exception

Bad Configuration Exception

BadRequestClass in namespace VuFind\Exception

"Bad Request" Exception

Form::buildForm() — Method in class Form

Build form.

$ Database#baseUrlProperty in class Database

Site base url

BasemapConfigClass in namespace VuFind\GeoFeatures

Basemap Configuration Class

$ Search2Factory#backendIdProperty in class Search2Factory

Search backend identifier.

$ Solr#backendIdProperty in class Solr

Search backend ID used for tree generation.

$ Solr#batchSizeProperty in class Solr

Record batch size

$ SolrFactory#backendIdProperty in class SolrFactory

Search backend identifier.

$ XMLFile#basePathProperty in class XMLFile

Base path to XML files

JSTree::buildNodeArray() — Method in class JSTree

Recursive function to convert the json to the right format

$ LocaleSettings#browserDetectLanguageProperty in class LocaleSettings

Should we use auto-detect language based on browser settings?

LocaleSettings::browserLanguageDetectionEnabled() — Method in class LocaleSettings

Should we use auto-detect language based on browser settings?

$ Aleph#bibProperty in class Aleph

Bibliographic bases

Aleph::barcodeToID() — Method in class Aleph

Convert a barcode to an item ID.

$ Alma#baseUrlProperty in class Alma

Alma API base URL.

$ DAIA#baseUrlProperty in class DAIA

Base URL for DAIA Service

Horizon::buildSqlFromArray() — Method in class Horizon

Protected support method for building sql strings.

$ Koha#blockTermsProperty in class Koha

Default terms for block types, can be overridden by configuration

$ KohaILSDI#blockTermsProperty in class KohaILSDI

Default terms for block types, can be overridden by configuration

Voyager::buildSqlFromArray() — Method in class Voyager

Protected support method for building sql strings.

VoyagerRestful::buildBasicXML() — Method in class VoyagerRestful

Build Basic XML

$ XCNCIP2#blockCodesProperty in class XCNCIP2

Mapping block messages from NCIP API to VuFind internal values

Mailer::buildMultipartBody() — Method in class Mailer

Constructs a {MimeMessage} body from given text and html content.

BEPressClass in namespace VuFind\MetadataVocabulary

Metadata vocabulary implementation for BEPress

$ Server#baseURLProperty in class Server

Repository base URL

$ Server#baseHostURLProperty in class Server

Base URL of host containing VuFind.

$ EuropeanaResults#baseUrlProperty in class EuropeanaResults

Europeana base URL

$ MapSelection#basemapOptionsProperty in class MapSelection

Basemap configuration parameters

$ MapSelection#bboxSearchCoordsProperty in class MapSelection

Bbox search box coordinates

$ RandomRecommend#backendProperty in class RandomRecommend

Backend to use

$ SwitchQuery#backendProperty in class SwitchQuery

Search backend identifier that we are working with.

$ TopFacets#baseSettingsProperty in class TopFacets

Basic configurations

BrowZineClass in namespace VuFind\RecordDriver

Model for BrowZine records.

$ Map#basemapOptionsProperty in class Map

Basemap settings

Loader::buildMissingRecord() — Method in class Loader

Build a "missing record" driver.

$ SourceAndIdList#bySourceProperty in class SourceAndIdList

Record positions in the original list, indexed by source and ID.

BookplateClass in namespace VuFind\Related

Related Records: Bookplates

$ Bookplate#bookplateStrsProperty in class Bookplate

Bookplate strings

$ Bookplate#bookplateImagesProperty in class Bookplate

Bookplate image names or full URLs

$ Bookplate#bookplateThumbnailsProperty in class Bookplate

Bookplate thumbnail image names or thumbnail URLs

BookplateFactoryClass in namespace VuFind\Related

Related record plugin factory

$ AbstractBase#baseUrlProperty in class AbstractBase

Base URL for link resolver

BackendManagerClass in namespace VuFind\Search

Manager for search backends.

BackendManagerFactoryClass in namespace VuFind\Search

Search Backend Manager factory.

BackendRegistryClass in namespace VuFind\Search

Registry for search backends.

$ HideFacetValueListener#backendProperty in class HideFacetValueListener
Backend.
HierarchicalFacetHelperInterface::buildFacetArray() — Method in class HierarchicalFacetHelperInterface

Helper method for building hierarchical facets: Convert facet list to a hierarchical array

$ Options#basicHandlersProperty in class Options

Basic search handlers

Params::buildGenericRangeFilter() — Method in class Params

Support method for initGenericRangeFilters() -- build a filter query based on a range of values.

Params::buildNumericRangeFilter() — Method in class Params

Support method for initNumericRangeFilters() -- build a filter query based on a range of numbers.

Params::buildDateRangeFilter() — Method in class Params

Support method for initDateFilters() -- build a filter query based on a range of 4-digit years.

Params::buildFullDateRangeFilter() — Method in class Params

Support method for initFullDateFilters() -- build a filter query based on a range of dates.

$ Results#backendIdProperty in class Results

Search backend identifier.

Results::buildFacetList() — Method in class Results

A helper method that converts the list of facets for the last search from RecordCollection's facet list.

$ Params#blenderConfigProperty in class Params

Blender configuration

$ Results#backendIdProperty in class Results

Search backend identifiers.

$ Results#backendIdProperty in class Results

Search backend identifier.

$ Results#backendIdProperty in class Results

Search backend identifier.

$ Results#backendIdProperty in class Results

Search backend identifier.

$ AbstractSolrBackendFactory#backendClassProperty in class AbstractSolrBackendFactory

Solr backend class

BlenderBackendFactoryClass in namespace VuFind\Search\Factory

Factory for Blender backend.

BrowZineBackendFactoryClass in namespace VuFind\Search\Factory

Factory for BrowZine backend.

$ BrowZineBackendFactory#browzineConfigProperty in class BrowZineBackendFactory

BrowZine configuration

$ PrimoBackendFactory#backendClassProperty in class PrimoBackendFactory

Primo backend class

$ Results#backendIdProperty in class Results

Search backend identifier.

$ Results#backendIdProperty in class Results

Search backend identifier.

$ Results#backendIdProperty in class Results

Search backend identifier.

$ Results#backendIdProperty in class Results

Search backend identifiers.

$ Results#backendIdProperty in class Results

Backend ID

$ Results#backendIdProperty in class Results

Search backend identifier.

$ Results#backendIdProperty in class Results

Search backend identifier.

$ Results#backendIdProperty in class Results

Search backend identifier.

$ AbstractErrorListener#backendsProperty in class AbstractErrorListener

Backends to listen for.

$ CustomFilterListener#backendProperty in class CustomFilterListener
Backend.
$ DeduplicationListener#backendProperty in class DeduplicationListener
Backend.
$ DefaultParametersListener#backendProperty in class DefaultParametersListener
Backend.
HierarchicalFacetHelper::buildFacetArray() — Method in class HierarchicalFacetHelper

Helper method for building hierarchical facets: Convert facet list to a hierarchical array

$ HierarchicalFacetListener#backendProperty in class HierarchicalFacetListener
Backend.
$ InjectHighlightingListener#backendProperty in class InjectHighlightingListener
Backend.
$ InjectSpellingListener#backendProperty in class InjectSpellingListener
Backend.
$ MultiIndexListener#backendProperty in class MultiIndexListener
Backend.
$ Results#backendIdProperty in class Results

Search backend identifier.

$ Results#bestBetsProperty in class Results

Best bets

$ Results#backendIdProperty in class Results

Search backend identifier.

UrlQueryHelper::buildQueryString() — Method in class UrlQueryHelper

Turn an array into a properly URL-encoded query string. This is equivalent to the built-in PHP http_build_query function, but it handles arrays in a more compact way and ensures that ampersands don't get messed up based on server-specific settings.

$ Results#backendIdProperty in class Results

Search backend identifier.

$ Generator#baseUrlProperty in class Generator

Base URL for site

$ Generator#baseSitemapUrlProperty in class Generator

Base URL for sitemap

Generator::buildIndex() — Method in class Generator

Write a sitemap index if requested.

$ ContentPages#baseUrlProperty in class ContentPages

Base URL for site

$ Index#baseUrlProperty in class Index

Base URL for site

$ Index#backendSettingsProperty in class Index

Settings specifying which backends to index.

$ StartPage#baseUrlProperty in class StartPage

Base URL for site

$ Database#baseUrlProperty in class Database

Base URL of current VuFind site

BrowseClass in namespace VuFind\View\Helper\Root

Browse controller view helper

SearchTabs::buildUrlHiddenFilters() — Method in class SearchTabs

Build a hidden filter query fragment from the given filters

C

$ ItemFormatterFactory#configFileProperty in class ItemFormatterFactory

Record fields configuration file name

ClearCacheCommandClass in namespace KnihovnyCzConsole\Command\Util

Class ClearCacheCommand

$ ClearCacheCommand#cacheManagerProperty in class ClearCacheCommand

Cache manager

ClearCacheCommand::configure() — Method in class ClearCacheCommand

Configure the command.

ClearCacheCommandFactoryClass in namespace KnihovnyCzConsole\Command\Util

Class ClearCacheCommandFactory

$ ExpireCsrfTokensCommand#commandDescriptionProperty in class ExpireCsrfTokensCommand

Help description for the command.

$ ExpireUsersCommand#commandDescriptionProperty in class ExpireUsersCommand

Help description for the command.

$ UpdateResourcesFromSolrCommand#converterProperty in class UpdateResourcesFromSolrCommand

Help description for the command.

CronjobClass in namespace KnihovnyCzCronApi\Controller

Class Cronjob

$ XCNCIP2Test#cancelHoldsTestsProperty in class XCNCIP2Test
$ XCNCIP2Test#cancelStorageRetrievalTestsProperty in class XCNCIP2Test
XCNCIP2Test::configureDriver() — Method in class XCNCIP2Test

Configure driver for test case

$ GetCitations#citaceProProperty in class GetCitations

CitacePro service

$ GetObalkyKnihCoverWithoutSolr#coverHandlerProperty in class GetObalkyKnihCoverWithoutSolr

Obálky knih cover handler

$ Sfx#configProperty in class Sfx
Configuration
Sfx::callSfx() — Method in class Sfx

Call SFX server and return links to fulltext.

$ Shibboleth#checkDuplicateInstitutionsProperty in class Shibboleth

Check for duplicities in library cards - only one library card for institution

Shibboleth::connectLibraryCard() — Method in class Shibboleth

Connect user authenticated by Shibboleth to library card.

$ Suggester#configManagerProperty in class Suggester

Configuration manager.

$ PluginFactory#configTableProperty in class PluginFactory

Configuration table

$ DocumentTypes#configManagerProperty in class DocumentTypes

Configuration manager

$ ObalkyKnihService#checkerUrlProperty in class ObalkyKnihService

Obalky knih checker

PageLocator::checkFileAvailability() — Method in class PageLocator

Check if file is available to download from HTTP based repository

CartControllerClass in namespace KnihovnyCz\Controller

Class CartController

CartController::citeAction() — Method in class CartController

Display cart contents.

CatalogLoginTraitClass in namespace KnihovnyCz\Controller

Class CatalogLoginTrait

CatalogLoginTrait::catalogLogin() — Method in class CatalogLoginTrait

Does the user have catalog credentials available? Returns associative array of patron data if so, otherwise forwards to appropriate login prompt and returns false. If there is an ILS exception, a flash message is added and a newly created ViewModel is returned.

ContentControllerClass in namespace KnihovnyCz\Controller

Class ContentController

ContentControllerFactoryClass in namespace KnihovnyCz\Controller

Class ContentControllerFactory

MyResearchController::checkedoutAction() — Method in class MyResearchController

Send list of checked out books to view

MyResearchController::checkedoutAjaxAction() — Method in class MyResearchController

Send user profile data as HTML for rendering in AJAX

Holds::cancelHolds() — Method in class Holds

Process cancellation requests.

ShortLoans::cancelShortLoans() — Method in class ShortLoans

Process cancellation requests.

ShortLoans::convertTime() — Method in class ShortLoans

Convert string to time as float

ShortLoans::createEmptySlot() — Method in class ShortLoans

Create empty slot

ConverterClass in namespace KnihovnyCz\Date

Date/time conversion functionality.

ConfigClass in namespace KnihovnyCz\Db\Row

Class Config

CsrfTokenClass in namespace KnihovnyCz\Db\Row

Class CsrfToken

$ User#cat_idProperty in class User
$ User#cat_usernameProperty in class User
$ User#cat_passwordProperty in class User
$ User#cat_pass_encProperty in class User
$ User#collegeProperty in class User
$ User#createdProperty in class User
User::couldManageInspirationLists() — Method in class User

Return true if user has privileges to create/edit inspiration lists

$ UserCard#card_nameProperty in class UserCard
$ UserCard#cat_usernameProperty in class UserCard
$ UserCard#cat_passwordProperty in class UserCard
$ UserCard#cat_pass_encProperty in class UserCard
$ UserCard#createdProperty in class UserCard
ConfigClass in namespace KnihovnyCz\Db\Table

Class Config

CsrfTokenClass in namespace KnihovnyCz\Db\Table

Class CsrfToken

ConnectionClass in namespace KnihovnyCz\ILS

Catalog Connection Class

Connection::checkFunction() — Method in class Connection

Check Function

Connection::checkCapability() — Method in class Connection

Check driver capability -- return true if the driver supports the specified method; false otherwise.

Connection::checkMethodgetMyShortLoans() — Method in class Connection

Check ShortLoans

Connection::checkMethodgetMyPaymentLink() — Method in class Connection

Check PaymentLink

Connection::checkMethodgetMyProlongRegistrationLink() — Method in class Connection

Check prolonging of registration

Aleph::cancelShortLoans() — Method in class Aleph

Cancel short loan requests

$ KohaRest1905#cacheTTLsProperty in class KohaRest1905

Cache lifetimes

KohaRest1905::cancelHolds() — Method in class KohaRest1905

Cancel Holds

KohaRest1905::checkRequestIsValid() — Method in class KohaRest1905

Check if request is valid

$ MultiConnection#containerProperty in class MultiConnection

Container for fetching AuthManager that can not be passed in constructor

MultiConnection::callAll() — Method in class MultiConnection

Call ILS method for every connected user card

SolrIdResolver::convertToIdUsingSolr() — Method in class SolrIdResolver

Do the actual id resolving

$ InvolvedLibrariesBuilder#configProperty in class InvolvedLibrariesBuilder
InvolvedLibrariesExtension::configureSchema() — Method in class InvolvedLibrariesExtension

Configure schema

$ InvolvedLibrariesParser#configProperty in class InvolvedLibrariesParser
$ RecommendOtherPortals#configLoaderProperty in class RecommendOtherPortals

Configuration loader

CitaceProTraitClass in namespace KnihovnyCz\RecordDriver\Feature

Trait CitaceProTrait

$ CitaceProTrait#citaceProProperty in class CitaceProTrait

CitacePro API service

WikidataTrait::createExternalIdentifiersSubquery() — Method in class WikidataTrait

Create Wikidata query for getting property values and corresponding formatters

CitesClass in namespace KnihovnyCz\RecordTab

Class Cited

ZiskejBase::convertLibsFromZiskej() — Method in class ZiskejBase

Convert libraries from Ziskej to library codes

ConnectorClass in namespace KnihovnyCz\Search\EDS\Backend

EBSCO EDS API Connector

EdsBackendFactory::createConnector() — Method in class EdsBackendFactory

Create the EDS connector.

$ SolrDefaultBackendFactory#connectorClassProperty in class SolrDefaultBackendFactory

Solr connector class

SolrDefaultBackendFactory::createListeners() — Method in class SolrDefaultBackendFactory

Create listeners.

SolrDefaultBackendFactory::createConnector() — Method in class SolrDefaultBackendFactory

Create the SOLR connector.

ConnectorClass in namespace KnihovnyCz\Search\Solr\Backend

SOLR connector.

ChildDocDeduplicationListenerClass in namespace KnihovnyCz\Search\Solr

Solr deduplication listener for views.

ChildDocDeduplicationListener::configureFilter() — Method in class ChildDocDeduplicationListener

Get filter for limiting results

$ JsonFacetListener#childFilterProperty in class JsonFacetListener

Child filter to apply to nested facets

$ MultiplyingDeduplicationListener#childFilterProperty in class MultiplyingDeduplicationListener

Child filter to apply

MultiplyingDeduplicationListener::configureFilter() — Method in class MultiplyingDeduplicationListener

Get filter for limiting results

CitaceProServiceClass in namespace KnihovnyCz\Service

Class CitaceProService

$ CitaceProService#configProperty in class CitaceProService
Configuration
CitaceProServiceFactoryClass in namespace KnihovnyCz\Service

Class CitaceProServiceFactory

GuzzleHttpService::createClient() — Method in class GuzzleHttpService

Return a new HTTP client.

$ UserSettingsService#configProperty in class UserSettingsService
Config
$ DatabaseCsrf#csrfTokenProperty in class DatabaseCsrf

CSRF token table

ContextHelpClass in namespace KnihovnyCz\View\Helper\KnihovnyCz

Context Help Helper

SearchTabs::createHomeTab() — Method in class SearchTabs

Create information representing a tab linking to "search home."

SearchTabs::createBasicTab() — Method in class SearchTabs

Create information representing a basic search tab.

SolrAuthorityTest::createDriver() — Method in class SolrAuthorityTest

Create new record driver

SolrLocalTest::createDriver() — Method in class SolrLocalTest

Create new record driver

SolrMarcTest::createDriver() — Method in class SolrMarcTest

Create new record driver

ConfigControllerClass in namespace VuFindAdmin\Controller

Class controls VuFind administration.

FeedbackController::confirmDelete() — Method in class FeedbackController

Confirm delete feedback messages

FeedbackController::convertFilter() — Method in class FeedbackController

Converts null and "ALL" params to null

MaintenanceController::clearcacheAction() — Method in class MaintenanceController

Clear cache(s).

TagsController::confirmTagsDelete() — Method in class TagsController

Confirm Delete by Id

TagsController::confirmTagsDeleteByFilter() — Method in class TagsController

Confirm Tag Delete by Filter

TagsController::convertFilter() — Method in class TagsController

Converts empty params and "ALL" to null

$ AdminApiController#cacheManagerProperty in class AdminApiController

Cache manager

$ AdminApiController#cacheAccessPermissionProperty in class AdminApiController

Permission required for the clear cache endpoint

AdminApiController::clearCacheAction() — Method in class AdminApiController

Clear the cache

$ RecordFormatterFactory#configFileProperty in class RecordFormatterFactory

Record fields configuration file name

$ Search2RecordFormatterFactory#configFileProperty in class Search2RecordFormatterFactory

Record fields configuration file name

$ WebRecordFormatterFactory#configFileProperty in class WebRecordFormatterFactory

Record fields configuration file name

$ ThemeCommand#compilerProperty in class ThemeCommand

Theme compiler

ThemeCommand::configure() — Method in class ThemeCommand

Configure the command.

$ AbstractContainerAwareCommand#containerProperty in class AbstractContainerAwareCommand

Top-level service container

AbstractThemeCommand::configure() — Method in class AbstractThemeCommand

Configure the command.

DynamicRouteCommand::configure() — Method in class DynamicRouteCommand

Configure the command.

ExtendClassCommand::configure() — Method in class ExtendClassCommand

Configure the command.

ExtendServiceCommand::configure() — Method in class ExtendServiceCommand

Configure the command.

NonTabRecordActionCommand::configure() — Method in class NonTabRecordActionCommand

Configure the command.

PluginCommand::configure() — Method in class PluginCommand

Configure the command.

RecordRouteCommand::configure() — Method in class RecordRouteCommand

Configure the command.

StaticRouteCommand::configure() — Method in class StaticRouteCommand

Configure the command.

$ ThemeCommand#configProperty in class ThemeCommand

Configuration from config.ini

HarvestOaiCommand::checkLocalSetting() — Method in class HarvestOaiCommand

Warn the user if VUFIND_LOCAL_DIR is not set.

MergeMarcCommand::configure() — Method in class MergeMarcCommand

Configure the command.

ImportCsvCommand::configure() — Method in class ImportCsvCommand

Configure the command.

ImportXslCommand::configure() — Method in class ImportXslCommand

Configure the command.

$ WebCrawlCommand#configProperty in class WebCrawlCommand

Configuration from webcrawl.ini

WebCrawlCommand::configure() — Method in class WebCrawlCommand

Configure the command.

InstallCommand::configure() — Method in class InstallCommand

Configure the command.

InstallCommand::collectParameters() — Method in class InstallCommand

Collect input parameters, and return a status (0 = proceed, 1 = fail).

AbstractCommand::createMissingFiles() — Method in class AbstractCommand

Create empty files if they do not already exist.

AddUsingTemplateCommand::configure() — Method in class AddUsingTemplateCommand

Configure the command.

CopyStringCommandClass in namespace VuFindConsole\Command\Language

Language command: copy string.

CopyStringCommand::configure() — Method in class CopyStringCommand

Configure the command.

DeleteCommand::configure() — Method in class DeleteCommand

Configure the command.

NormalizeCommand::configure() — Method in class NormalizeCommand

Configure the command.

NotifyCommand::configure() — Method in class NotifyCommand

Configure the command.

$ AbstractCssBuilderCommand#cacheDirProperty in class AbstractCssBuilderCommand

Cache directory for compiler

AbstractCssBuilderCommand::configure() — Method in class AbstractCssBuilderCommand

Configure the command.

$ AbstractExpireCommand#commandDescriptionProperty in class AbstractExpireCommand

Help description for the command.

AbstractExpireCommand::configure() — Method in class AbstractExpireCommand

Configure the command.

$ AbstractSolrAndIlsCommand#catalogProperty in class AbstractSolrAndIlsCommand

ILS connection

CleanUpRecordCacheCommandClass in namespace VuFindConsole\Command\Util

Console command: clean up record cache.

CleanUpRecordCacheCommand::configure() — Method in class CleanUpRecordCacheCommand

Configure the command.

CleanUpRecordCacheCommandFactoryClass in namespace VuFindConsole\Command\Util

Factory for Util/CleanUpRecordCache command.

CommitCommandClass in namespace VuFindConsole\Command\Util

Console command: commit to Solr

CommitCommand::configure() — Method in class CommitCommand

Configure the command.

CreateHierarchyTreesCommandClass in namespace VuFindConsole\Command\Util

Generic base class for Solr commands.

CreateHierarchyTreesCommand::configure() — Method in class CreateHierarchyTreesCommand

Configure the command.

CreateHierarchyTreesCommandFactoryClass in namespace VuFindConsole\Command\Util

Factory for Util/CreateHierarchyTrees command.

DedupeCommand::configure() — Method in class DedupeCommand

Configure the command.

DedupeCommand::closeOutputFile() — Method in class DedupeCommand

Close a file handle.

DeletesCommand::configure() — Method in class DeletesCommand

Configure the command.

$ ExpireAccessTokensCommand#commandDescriptionProperty in class ExpireAccessTokensCommand

Help description for the command.

$ ExpireAuthHashesCommand#commandDescriptionProperty in class ExpireAuthHashesCommand

Help description for the command.

$ ExpireExternalSessionsCommand#commandDescriptionProperty in class ExpireExternalSessionsCommand

Help description for the command.

$ ExpireSearchesCommand#commandDescriptionProperty in class ExpireSearchesCommand

Help description for the command.

$ ExpireSessionsCommand#commandDescriptionProperty in class ExpireSessionsCommand

Help description for the command.

IndexReservesCommand::configure() — Method in class IndexReservesCommand

Configure the command.

LintMarcCommand::configure() — Method in class LintMarcCommand

Configure the command.

SitemapCommand::configure() — Method in class SitemapCommand

Configure the command.

SuppressedCommand::configure() — Method in class SuppressedCommand

Configure the command.

$ SwitchDbHashCommand#configProperty in class SwitchDbHashCommand

VuFind configuration.

SwitchDbHashCommand::configure() — Method in class SwitchDbHashCommand

Configure the command.

ConsoleOutputTraitClass in namespace VuFindConsole

Console output trait (used to add output support to other classes).

ConsoleRunnerClass in namespace VuFindConsole

Console runner.

$ ConsoleRunner#commandsProperty in class ConsoleRunner

List of commands

ConsoleRunnerFactoryClass in namespace VuFindConsole

Console runner factory.

$ GeneratorTools#configProperty in class GeneratorTools

Laminas configuration

GeneratorTools::createPlugin() — Method in class GeneratorTools

Create a plugin class.

GeneratorTools::cloneFactory() — Method in class GeneratorTools

Create a new subclass and factory to override a factory-generated service.

GeneratorTools::createClassInModule() — Method in class GeneratorTools

Extend a specified class within a specified module. Return the name of the new subclass.

GeneratorTools::createSubclassInModule() — Method in class GeneratorTools

Extend a specified class within a specified module. Return the name of the new subclass.

GeneratorTools::createTree() — Method in class GeneratorTools

Create a directory tree.

$ LanguageHelper#configuredLanguagesProperty in class LanguageHelper

Configured languages (code => description)

LanguageHelper::compareLanguages() — Method in class LanguageHelper

Compare two languages and return an array of details about how they differ.

$ AbstractBackend#collectionFactoryProperty in class AbstractBackend

Record collection factory.

$ Backend#configProperty in class Backend

Blender configuration

Backend::createRecordCollection() — Method in class Backend

Create record collection.

Backend::collectEventResults() — Method in class Backend

Collect results back into the Command after an event has been processed

Backend::convertSearchEvent() — Method in class Backend

Convert a search event to another backend

$ RecordCollection#configProperty in class RecordCollection

Blender configuration

RecordCollection::collectBackendRecords() — Method in class RecordCollection

Collect records from all backends to an associative array

RecordCollection::convertFacetValue() — Method in class RecordCollection

Convert a facet value from a backend

$ Backend#connectorProperty in class Backend
Connector.
Backend::createRecordCollection() — Method in class Backend

Create record collection.

ConnectorClass in namespace VuFindSearch\Backend\BrowZine

BrowZine connector.

$ Connector#clientProperty in class Connector

The HTTP Request client used for API transactions

$ RecordCollectionFactory#collectionClassProperty in class RecordCollectionFactory

Class of collection.

$ Backend#clientProperty in class Backend

Client user to make the actually requests to the EdsApi

$ Backend#cacheProperty in class Backend

Object cache (for storing authentication tokens)

Backend::createRecordCollection() — Method in class Backend

Create record collection.

Backend::createEBSCOSession() — Method in class Backend

Generate a new session token and store it in the Session container.

Backend::createSession() — Method in class Backend

Obtain the session to use with the EDS API from cache if it exists. If not, then generate a new one.

$ Base#contentTypeProperty in class Base

Content type header

Base::createSession() — Method in class Base

Creates a new session

Base::createQSFromArray() — Method in class Base

Convert an array of search parameters to EDS API querystring parameters

Base::call() — Method in class Base

Submit REST Request

ConnectorClass in namespace VuFindSearch\Backend\EDS

EBSCO EDS API Connector

$ Connector#clientProperty in class Connector

The HTTP Request object to execute EDS API transactions

$ RecordCollectionFactory#collectionClassProperty in class RecordCollectionFactory

Class of collection.

SearchRequestModel::convertToQueryString() — Method in class SearchRequestModel

Converts properties to a querystring to send to the EdsAPI

SearchRequestModel::convertToQueryStringParameterArray() — Method in class SearchRequestModel

Converts properties to a querystring to send to the EdsAPI

SearchRequestModel::convertToSearchRequestJSON() — Method in class SearchRequestModel

Converts properties to a search request JSON document to send to the EdsAPI

$ Backend#connectorProperty in class Backend
Connector.
Backend::createRecordCollection() — Method in class Backend

Create record collection.

ConnectorClass in namespace VuFindSearch\Backend\EIT

Central class for connecting to EIT resources used by VuFind.

$ Connector#clientProperty in class Connector

The HTTP_Request object used for REST transactions

Connector::checkForHttpError() — Method in class Connector

Check for HTTP errors in a response.

Connector::call() — Method in class Connector

Make an API call

$ RecordCollectionFactory#collectionClassProperty in class RecordCollectionFactory

Class of collection.

HttpErrorException::createFromResponse() — Method in class HttpErrorException

Exception factory.

ConnectorCacheTraitClass in namespace VuFindSearch\Backend\Feature

Caching support trait for connectors.

$ ConnectorCacheTrait#cacheProperty in class ConnectorCacheTrait

Request cache

$ Backend#connectorProperty in class Backend
Connector.
Backend::createRecordCollection() — Method in class Backend

Create record collection.

ConnectorClass in namespace VuFindSearch\Backend\LibGuides

LibGuides connector.

$ Connector#clientProperty in class Connector

The HTTP_Request object used for API transactions

Connector::call() — Method in class Connector

Small wrapper for sendRequest, process to simplify error handling.

$ RecordCollectionFactory#collectionClassProperty in class RecordCollectionFactory

Class of collection.

$ Backend#connectorProperty in class Backend
Connector.
Backend::createRecordCollection() — Method in class Backend

Create record collection.

ConnectorClass in namespace VuFindSearch\Backend\Pazpar2

Central class for connecting to resources used by VuFind.

$ Connector#clientProperty in class Connector

The HTTP_Request object used for REST transactions

$ RecordCollectionFactory#collectionClassProperty in class RecordCollectionFactory

Class of collection.

$ Backend#connectorProperty in class Backend
Connector.
Backend::createRecordCollection() — Method in class Backend

Create record collection.

ConnectorClass in namespace VuFindSearch\Backend\Primo

Primo Central connector.

$ Connector#clientProperty in class Connector

HTTP client used for API transactions

Connector::call() — Method in class Connector

Small wrapper for sendRequest, process to simplify error handling.

$ RecordCollectionFactory#collectionClassProperty in class RecordCollectionFactory

Class of collection.

ConnectorClass in namespace VuFindSearch\Backend\SRU

SRU Search Interface

$ Connector#clientProperty in class Connector

The HTTP_Request object used for REST transactions

Connector::checkForHttpError() — Method in class Connector

Check for HTTP errors in a response.

Connector::call() — Method in class Connector

Submit REST Request

$ Backend#connectorProperty in class Backend
Connector.
Backend::createRecordCollection() — Method in class Backend

Create record collection.

ConnectorClass in namespace VuFindSearch\Backend\Solr

SOLR connector.

$ Connector#clientFactoryProperty in class Connector

HTTP client factory

Connector::callWithHttpOptions() — Method in class Connector

Call a method with provided options for the HTTP client

CommitDocumentClass in namespace VuFindSearch\Backend\Solr\Document

SOLR commit document class.

$ CommitDocument#commitWithinProperty in class CommitDocument

Value for commitWithin attribute

$ RawDocument#contentProperty in class RawDocument

Raw document text

$ LuceneSyntaxHelper#caseSensitiveRangesProperty in class LuceneSyntaxHelper

Force ranges to uppercase?

$ LuceneSyntaxHelper#caseSensitiveBooleansProperty in class LuceneSyntaxHelper

Force boolean operators to uppercase? Set to true to make all Booleans case-sensitive; false to make no Booleans case-sensitive; comma-separated string to make only certain operators case sensitive.

LuceneSyntaxHelper::containsBooleans() — Method in class LuceneSyntaxHelper

Return true if the search string contains boolean operators.

LuceneSyntaxHelper::containsRanges() — Method in class LuceneSyntaxHelper

Return true if the search string contains ranges.

LuceneSyntaxHelper::containsAdvancedLuceneSyntax() — Method in class LuceneSyntaxHelper

Return true if the search string contains advanced Lucene syntax.

LuceneSyntaxHelper::capitalizeCaseInsensitiveBooleans() — Method in class LuceneSyntaxHelper

Wrapper around capitalizeBooleans that accounts for the caseSensitiveBooleans property of this class.

LuceneSyntaxHelper::capitalizeBooleans() — Method in class LuceneSyntaxHelper

Capitalize boolean operators.

LuceneSyntaxHelper::capitalizeRanges() — Method in class LuceneSyntaxHelper

Capitalize range operator.

LuceneSyntaxHelper::capitalizeRangesCallback() — Method in class LuceneSyntaxHelper

Callback helper function.

LuceneSyntaxHelper::countNonQuoted() — Method in class LuceneSyntaxHelper

Count occurrences of a character in non-quoted parts of the string

$ QueryBuilder#createSpellingQueryProperty in class QueryBuilder

Should we create the spellcheck.q parameter when appropriate?

QueryBuilder::checkParamConditions() — Method in class QueryBuilder

Check if the conditions match for an extra parameter

QueryBuilder::createSearchString() — Method in class QueryBuilder

Return search string based on input and handler.

QueryBuilder::createAdvancedInnerSearchString() — Method in class QueryBuilder

Return advanced inner search string based on input and handler.

$ NamedList#currentProperty in class NamedList

The current position

NamedList::count() — Method in class NamedList

Return count of elements.

NamedList::current() — Method in class NamedList

Return current element value.

$ RecordCollectionFactory#collectionClassProperty in class RecordCollectionFactory

Class of collection.

Spellcheck::count() — Method in class Spellcheck

Return number of terms.

Spellcheck::contains() — Method in class Spellcheck

Return true if we already have information for the term.

Spellcheck::compareTermLength() — Method in class Spellcheck

Compare length of two terms such that terms are sorted by descending length.

$ SearchHandler#configKeysProperty in class SearchHandler

Known configuration keys.

SearchHandler::createAdvancedQueryString() — Method in class SearchHandler

Return an advanced query string.

SearchHandler::createSimpleQueryString() — Method in class SearchHandler

Return a simple query string.

SearchHandler::createBoostQueryString() — Method in class SearchHandler

Return an advanced query string for specified search string.

SearchHandler::customMunge() — Method in class SearchHandler

Apply a munge operation to a search string.

SearchHandler::createQueryString() — Method in class SearchHandler

Return query string for specified search string.

$ SimilarBuilder#countProperty in class SimilarBuilder

Number of similar records to retrieve

$ Backend#connectorProperty in class Backend
Connector.
Backend::createRecordCollection() — Method in class Backend

Create record collection.

$ RecordCollectionFactory#collectionClassProperty in class RecordCollectionFactory

Class of collection.

$ Backend#connectorProperty in class Backend
Connector.
Backend::createRecordCollection() — Method in class Backend

Create record collection.

ConnectorClass in namespace VuFindSearch\Backend\WorldCat

WorldCat SRU Search Interface

$ RecordCollectionFactory#collectionClassProperty in class RecordCollectionFactory

Class of collection.

$ AbstractBase#contextProperty in class AbstractBase

Command context

CallMethodCommandClass in namespace VuFindSearch\Command

Call method command.

CommandInterfaceClass in namespace VuFindSearch\Command

Command interface definition.

ParamBag::count() — Method in class ParamBag

Count parameters in internal array. Needed for Countable interface.

ParamBag::contains() — Method in class ParamBag

Return true if the bag contains a parameter-value-pair.

Query::containsTerm() — Method in class Query

Does the query contain the specified term? An optional normalizer can be provided to allow for fuzzier matching.

QueryGroup::containsTerm() — Method in class QueryGroup

Does the query contain the specified term? An optional normalizer can be provided to allow for fuzzier matching.

QueryInterface::containsTerm() — Method in class QueryInterface

Does the query contain the specified term? An optional normalizer can be provided to allow for fuzzier matching.

AbstractRecordCollection::current() — Method in class AbstractRecordCollection

Return record at current collection index.

AbstractRecordCollection::count() — Method in class AbstractRecordCollection

Return number of records in collection.

CheckRequestIsValidTestClass in namespace VuFindTest\AjaxHandler

CheckRequestIsValid test class.

CommentRecordTestClass in namespace VuFindTest\AjaxHandler

CommentRecord test class.

ChoiceAuthTestClass in namespace VuFindTest\Auth

ChoiceAuth test class.

$ MultiILSTest#containerProperty in class MultiILSTest

Container for building mocks.

$ BackendTest#configProperty in class BackendTest

Blender config

ConnectorTestClass in namespace VuFindTest\Backend\EDS

Unit tests for EDS connector.

ConnectorTest::createConnector() — Method in class ConnectorTest

Create connector with fixture file.

ConnectorTest::createClient() — Method in class ConnectorTest

Set up HTTP client using test adapter with prepared response.

ConnectorTestClass in namespace VuFindTest\Backend\Primo

Unit tests for Primo connector.

ConnectorTest::createConnector() — Method in class ConnectorTest

Create connector with fixture file.

ConnectorTestClass in namespace VuFindTest\Backend\Solr

Unit tests for SOLR connector.

ConnectorTest::createConnector() — Method in class ConnectorTest

Create connector with fixture file.

ConnectorTest::createClient() — Method in class ConnectorTest

Set up HTTP client using test adapter with prepared response.

CommitDocumentTestClass in namespace VuFindTest\Backend\Solr\Document

Unit tests for SOLR update document class.

LuceneSyntaxHelperTest::capitalizeBooleansProvider() — Method in class LuceneSyntaxHelperTest

Data provider for testCapitalizeBooleans

LuceneSyntaxHelperTest::capitalizeRangesProvider() — Method in class LuceneSyntaxHelperTest

Data provider for testCapitalizeRanges

LuceneSyntaxHelperTest::colonNormalizationProvider() — Method in class LuceneSyntaxHelperTest

Data provider for testColonNormalization

ConnectorTestClass in namespace VuFindTest\Backend\WorldCat

Unit tests for WorldCat backend.

$ ImporterTest#csvFixtureDirProperty in class ImporterTest

Location of fixture files.

$ ImporterTest#containerProperty in class ImporterTest

Mock container for use by tests.

$ ImageFactoryTest#constructorArgsProperty in class ImageFactoryTest

Constructor arguments

CartTestClass in namespace VuFindTest

Cart Test Class

AlphaBrowseTest::configureTestTargetAndExpectations() — Method in class AlphaBrowseTest

Support method to mock objects.

SimilarItemsTest::configureTestTargetAndExpectations() — Method in class SimilarItemsTest

Support method to mock objects.

CopyStringCommandTestClass in namespace VuFindTest\Command\Language

Language/CopyString command test.

$ NotifyCommandTest#containerProperty in class NotifyCommandTest

Container for building mocks.

CleanUpRecordCacheCommandTestClass in namespace VuFindTest\Command\Util

CleanUpRecordCacheCommand test.

CommitCommandTestClass in namespace VuFindTest\Command\Util

CommitCommand test.

CreateHierarchyTreesCommandTestClass in namespace VuFindTest\Command\Util

CreateHierarchyTreesCommand test.

CacheDecoratorTestClass in namespace VuFindTest\Config\Reader

Config CacheDecorator test class.

UpgradeTest::checkVersion() — Method in class UpgradeTest

Perform standard tests for the specified version and return resulting configs and warnings so that further assertions can be performed by calling code if necessary.

MockContainerTrait::createMock() — Method in class MockContainerTrait

Create a mock object.

ContentCafeTestClass in namespace VuFindTest\Content\Covers

Unit tests for ContentCafe cover loader.

$ HoldsTest#containerProperty in class HoldsTest

Mock container

ContainerTestClass in namespace VuFindTest\Cookie

Cookie Container Test Class

$ ContainerTest#containerProperty in class ContainerTest

Cookie container

CssPreCompilerTestClass in namespace VuFindTest

CssPreCompilerTest Test Class

$ CssPreCompilerTest#compilerProperty in class CssPreCompilerTest

Our brave test subject

ChangeTrackerTestClass in namespace VuFindTest\Db\Table

ChangeTracker Test Class

ConfigPluginManagerTraitClass in namespace VuFindTest\Feature

Trait for configuration handling in tests.

LiveDetectionTrait::continuousIntegrationRunning() — Method in class LiveDetectionTrait

Is this test running in a continuous integration context?

LiveSolrTrait::createLiveSolrContainer() — Method in class LiveSolrTrait

Create and populate container for services related to live Solr connectivity.

ReflectionTrait::callMethod() — Method in class ReflectionTrait

Call protected or private method for side-effect and result.

CachingDownloaderTestClass in namespace VuFindTest\Http

CachingDownloader Test Class

ExtendedIniNormalizerTest::checkDirectory() — Method in class ExtendedIniNormalizerTest

Test language integrity inside a directory.

SorterTest::compareProvider() — Method in class SorterTest

Data Provider for compare tests

SorterTest::createSorter() — Method in class SorterTest

Create sorter

DAIATest::createConnector() — Method in class DAIATest

Create connector with fixture file.

FolioTest::createConnector() — Method in class FolioTest

Generate a new Folio driver to return responses set in a json fixture

$ GeniePlusTest#configProperty in class GeniePlusTest

Default driver configuration

ILSMockTrait::cancelHolds() — Method in class ILSMockTrait
ILSMockTrait::cancelILLRequests() — Method in class ILSMockTrait
ILSMockTrait::cancelStorageRetrievalRequests() — Method in class ILSMockTrait
ILSMockTrait::checkRequestIsValid() — Method in class ILSMockTrait
ILSMockTrait::checkILLRequestIsValid() — Method in class ILSMockTrait
ILSMockTrait::checkStorageRetrievalRequestIsValid() — Method in class ILSMockTrait
PAIATest::createConnector() — Method in class PAIATest

Create connector with fixture file.

PAIATest::createMockConnector() — Method in class PAIATest

Create connector with fixture file.

$ XCNCIP2Test#cancelHoldsTestsProperty in class XCNCIP2Test

Test definition for testCancelHolds

$ XCNCIP2Test#cancelStorageRetrievalTestsProperty in class XCNCIP2Test

Test definition for testCancelStorageRetrievalRequests

XCNCIP2Test::configureDriver() — Method in class XCNCIP2Test

Configure driver for test case

OAuth2TokenTraitTest::configureDriver() — Method in class OAuth2TokenTraitTest

Basic configuration for tested service

MinkTestCase::changeConfigs() — Method in class MinkTestCase

Reconfigure VuFind for the current test.

MinkTestCase::changeYamlConfigs() — Method in class MinkTestCase

Reconfigure VuFind for the current test.

MinkTestCase::changeConfigFile() — Method in class MinkTestCase

Support method for changeConfig; act on a single file.

MinkTestCase::changeYamlConfigFile() — Method in class MinkTestCase

Support method for changeYamlConfig; act on a single file.

MinkTestCase::checkVisibility() — Method in class MinkTestCase

Test an element for visibility.

MinkTestCase::clickCss() — Method in class MinkTestCase

Click on a CSS element.

MinkTestCase::closeLightbox() — Method in class MinkTestCase

Verify that lightbox title contains the expected value

ExampleExtension::configureSchema() — Method in class ExampleExtension

Set configuration schema

AccountMenuTest::checkIcon() — Method in class AccountMenuTest

Abstracted test to set storage and check if the icon is correct

BulkTest::checkForNonSelectedMessage() — Method in class BulkTest

Assert that the "no items were selected" message is visible in the lightbox.

BulkTest::checkForLoginMessage() — Method in class BulkTest

Assert that the "login required" message is visible in the lightbox.

CallnumberBrowseTestClass in namespace VuFindTest\Mink

Mink search actions test class.

CallnumberBrowseTest::changeCallnumberSettings() — Method in class CallnumberBrowseTest

Set config for callnumber tests Sets callnumber_handler to false

CallnumberBrowseTest::checkLink() — Method in class CallnumberBrowseTest

Checks if a link has the correct callnumber and setting

CartTestClass in namespace VuFindTest\Mink

Mink cart test class.

CartTest::checkEmptyCart() — Method in class CartTest

Assert that the open cart lightbox is empty.

CartTest::checkForNonSelectedMessage() — Method in class CartTest

Assert that the "no items were selected" message is visible in the cart lightbox.

CartTest::checkForLoginMessage() — Method in class CartTest

Assert that the "login required" message is visible in the cart lightbox.

ChannelsTestClass in namespace VuFindTest\Mink

Mink cart test class.

ChoiceAuthTestClass in namespace VuFindTest\Mink

Mink ChoiceAuth test class.

CollectionsTestClass in namespace VuFindTest\Mink

Mink test class for basic collection functionality.

CombinedSearchTestClass in namespace VuFindTest\Mink

Mink test class for combined search.

CookieConsentTestClass in namespace VuFindTest\Mink

Mink cookie consent test class.

FavoritesTest::checkForNonSelectedMessage() — Method in class FavoritesTest

Assert that the "no items were selected" message is visible in the cart lightbox.

HoldsTest::clickButtonGroupLink() — Method in class HoldsTest

Click a link inside a drop down button group.

HoldsTest::cancelProcedure() — Method in class HoldsTest

Test canceling a request.

IlsActionsTest::clickButtonGroupLink() — Method in class IlsActionsTest

Click a link inside a drop down button group.

IlsActionsTest::cancelSelectedProcedure() — Method in class IlsActionsTest

Test canceling a request with the "cancel selected" button.

IlsActionsTest::cancelAllProcedure() — Method in class IlsActionsTest

Test canceling a request with the "cancel all" button.

OAuth2Test::createOpenSSLKeyPair() — Method in class OAuth2Test

Create a public/private key pair

SavedSearchesTest::clickSaveLink() — Method in class SavedSearchesTest

Click on the "Save Search" link in a search result set (or fail trying).

SearchFacetsTest::clickHierarchyFacet() — Method in class SearchFacetsTest

Support method to click a hierarchical facet.

AbstractTokenRepositoryTest::createAccessTokenRow() — Method in class AbstractTokenRepositoryTest

Create AccessToken row

AbstractTokenRepositoryTest::createTokenId() — Method in class AbstractTokenRepositoryTest

Create a token ID.

AbstractTokenRepositoryTest::createExpiryDateTime() — Method in class AbstractTokenRepositoryTest

Create an expiry datetime.

AbstractTokenRepositoryTest::createClientEntity() — Method in class AbstractTokenRepositoryTest

Create a client entity

ClientRepositoryTestClass in namespace VuFindTest\OAuth2\Repository

OAuth2 ClientRepository tests.

CollectionSideFacetsTestClass in namespace VuFindTest\Recommend

CollectionSideFacets recommendation module Test Class

MarcBasicTraitTest::createMockRecord() — Method in class MarcBasicTraitTest

Create mock record

CollectionHierarchyTreeTestClass in namespace VuFindTest\RecordTab

CollectionHierarchyTree Test Class

ComponentPartsTestClass in namespace VuFindTest\RecordTab

ComponentParts Test Class

CacheTestClass in namespace VuFindTest\Record

Record cache tests.

ChecklistTestClass in namespace VuFindTest\Record

Checklist tests.

CsvReaderTestClass in namespace VuFindTest\Reserves

Course Reserves CSV Loader Test Class

AlmaTest::createConnector() — Method in class AlmaTest

Create connector with fixture file.

JopTest::createConnector() — Method in class JopTest

Create connector with fixture file.

RediTest::createConnector() — Method in class RediTest

Create connector with fixture file.

ServerParamTest::checkServerParams() — Method in class ServerParamTest

Setup request and header objects, run getPermissions and check the result

ShibbolethTest::checkShibboleth() — Method in class ShibbolethTest

Setup request and shibboleth objects, run getPermissions and check the result

UserTest::check() — Method in class UserTest

Convenience method for executing similar tests

ClickatellTestClass in namespace VuFindTest\SMS

SMS test

SearchServiceTest::createMockBackend() — Method in class SearchServiceTest

Create a mock backend.

$ ParamsTest#configProperty in class ParamsTest

Blender config

$ ParamsTest#configManagerProperty in class ParamsTest

Mock config manager

ConditionalFilterListenerTestClass in namespace VuFindTest\Search\Solr

Unit tests for Conditional Filter listener.

CustomFilterListenerTestClass in namespace VuFindTest\Search\Solr

Unit tests for Custom Filter Listener.

ErrorListenerTest::createResponse() — Method in class ErrorListenerTest

Return response fixture

ErrorListenerTest::createResponse() — Method in class ErrorListenerTest

Return response fixture

CursorMarkIdFetcherTestClass in namespace VuFindTest\Sitemap\Command

CursorMarkIdFetcher Test Class

$ CursorMarkIdFetcherTest#countPerPageProperty in class CursorMarkIdFetcherTest

Page size to use in tests

$ TermsIdFetcherTest#countPerPageProperty in class TermsIdFetcherTest

Page size to use in tests

$ GeneratorTest#containerProperty in class GeneratorTest

Mock container

ContentPagesTestClass in namespace VuFindTest\Sitemap\Plugin

ContentPages Plugin Test Class

$ ContentPagesTest#containerProperty in class ContentPagesTest

Mock container

$ AjaxHandlerTest#containerProperty in class AjaxHandlerTest

Mock container

CartTestClass in namespace VuFindTest\View\Helper\Root

Cart view helper Test Class

CitationTestClass in namespace VuFindTest\View\Helper\Root

CitationBuilder Test Class

$ CitationTest#citationsProperty in class CitationTest

Sample citations -- each element of this array contains three elements -- the raw input data and the expected apa/mla output citations.

ComponentTestClass in namespace VuFindTest\View\Helper\Root

Component Test Class

ContentTestClass in namespace VuFindTest\View\Helper\Root

Content View Helper Test Class

CookieConsentTestClass in namespace VuFindTest\View\Helper\Root

Cookie Consent View Helper Test Class

CspTestClass in namespace VuFindTest\View\Helper\Root

Csp View Helper Test Class

CurrencyFormatterTestClass in namespace VuFindTest\View\Helper\Root

CurrencyFormatter Test Class

AbstractCssPreCompiler::compile() — Method in class AbstractCssPreCompiler

Compile the scripts.

AbstractThemeUtility::copyDir() — Method in class AbstractThemeUtility

Copy the contents of $src into $dest if no matching files already exist.

$ Initializer#configProperty in class Initializer

Theme configuration object

$ Initializer#cookieManagerProperty in class Initializer

Cookie manager

CSSClass in namespace VuFindTheme\Minify

CSS minifier extensions

PathConverter::convert() — Method in class PathConverter

Convert paths relative to the themes directory.

$ ResourceContainer#cssProperty in class ResourceContainer

CSS files

ThemeCompiler::compile() — Method in class ThemeCompiler

Compile from $source theme into $target theme.

ThemeGenerator::configure() — Method in class ThemeGenerator

Configure the specified theme as VuFind's new default theme (and one of the alternatives).

$ ThemeInfo#currentThemeProperty in class ThemeInfo

Current selected theme

$ ThemeInfo#cacheProperty in class ThemeInfo

Cache for merged configs

ConcatTraitClass in namespace VuFindTheme\View\Helper

Trait to add asset pipeline functionality (concatenation / minification) to a HeadLink/HeadScript-style view helper.

$ ConcatTrait#concatIndexProperty in class ConcatTrait

Future order of the concatenated file

ConcatTrait::createConcatenatedFile() — Method in class ConcatTrait

Create a concatenated file from the given group of files

$ HeadLink#cspNonceProperty in class HeadLink

CSP nonce

$ HeadScript#cspNonceProperty in class HeadScript

CSP nonce

$ SetupThemeResources#containerProperty in class SetupThemeResources

Theme resource container

Slot::clear() — Method in class Slot

Unset any values stored in a slot.

CheckRequestIsValidClass in namespace VuFind\AjaxHandler

"Check Request is Valid" AJAX handler

CommentRecordClass in namespace VuFind\AjaxHandler

AJAX handler to comment on a record.

$ CommentRecord#captchaProperty in class CommentRecord

Captcha controller plugin

CommentRecord::checkCaptcha() — Method in class CommentRecord

Is CAPTCHA valid? (Also returns true if CAPTCHA is disabled).

CommentRecordFactoryClass in namespace VuFind\AjaxHandler

Factory for CommentRecord AJAX handler.

$ GetItemStatuses#configProperty in class GetItemStatuses

Top-level configuration

$ GetRecordCover#coverRouterProperty in class GetRecordCover

Cover router

$ GetRecordDetails#configProperty in class GetRecordDetails

Framework configuration

$ GetResolverLinks#configProperty in class GetResolverLinks

Top-level VuFind configuration (config.ini)

$ GetUserFines#currencyFormatterProperty in class GetUserFines

Currency formatter

$ SystemStatus#configProperty in class SystemStatus

Top-level VuFind configuration (config.ini)

$ AbstractBase#configValidatedProperty in class AbstractBase

Has the configuration been validated?

$ AbstractBase#configProperty in class AbstractBase

Configuration settings

AbstractBase::create() — Method in class AbstractBase

Create a new user account from the request.

$ AlmaDatabase#catalogProperty in class AlmaDatabase

Catalog connection

AlmaDatabase::create() — Method in class AlmaDatabase

Create a new user account in Alma AND in the VuFind Database.

CASClass in namespace VuFind\Auth

CAS authentication module.

ChoiceAuthClass in namespace VuFind\Auth

ChoiceAuth Authentication plugin

ChoiceAuth::create() — Method in class ChoiceAuth

Create a new user account from the request.

ChoiceAuthFactoryClass in namespace VuFind\Auth

Factory for ChoiceAuth authentication module.

Database::create() — Method in class Database

Create a new user account from the request.

Database::checkEmailVerified() — Method in class Database

Check if the user's email address has been verified (if necessary) and throws exception if not.

Database::checkPassword() — Method in class Database

Check that the user's password matches the provided value.

Database::collectParamsFromRequest() — Method in class Database

Collect parameters from request and populate them.

Database::createUserFromParams() — Method in class Database

Create a user row object from given parametes.

$ EmailAuthenticator#csrfProperty in class EmailAuthenticator

CSRF Validator

$ EmailAuthenticator#configProperty in class EmailAuthenticator
Configuration
$ ILS#catalogProperty in class ILS

Catalog connection

$ ILSAuthenticator#catalogProperty in class ILSAuthenticator

ILS connector

LDAP::checkLdap() — Method in class LDAP

Communicate with LDAP and obtain user details.

LDAP::connect() — Method in class LDAP

Establish the LDAP connection.

$ Manager#configProperty in class Manager

VuFind configuration

$ Manager#cookieManagerProperty in class Manager

Cookie Manager

$ Manager#currentUserProperty in class Manager

Cache for current logged in user object

$ Manager#csrfProperty in class Manager

CSRF validator

Manager::checkForExpiredCredentials() — Method in class Manager

Resets the session if the logged in user's credentials have expired.

Manager::create() — Method in class Manager

Create a new user account from the request.

Manager::connectLibraryCard() — Method in class Manager

Connect authenticated user as library card to his account.

$ Shibboleth#configurationLoaderProperty in class Shibboleth

Configuration loading implementation

Shibboleth::connectLibraryCard() — Method in class Shibboleth

Connect user authenticated by Shibboleth to library card.

ConfigurationLoaderInterfaceClass in namespace VuFind\Auth\Shibboleth

Configuration loader interface

$ MultiIdPConfigurationLoader#configProperty in class MultiIdPConfigurationLoader

Configured IdPs with entityId and overridden attribute mapping

$ SingleIdPConfigurationLoader#configProperty in class SingleIdPConfigurationLoader

Configured IdPs with entityId and overridden attribute mapping

$ Suggester#configManagerProperty in class Suggester

Configuration manager.

$ Bootstrapper#configProperty in class Bootstrapper

Main VuFind configuration

$ Bootstrapper#containerProperty in class Bootstrapper

Service manager

$ Importer#configBaseDirProperty in class Importer

Base path for loading .ini files

Importer::collectValuesFromLine() — Method in class Importer

Collect field-specific values from a CSV input line. Returns an array mapping field name to value array.

$ ImporterConfig#columnsProperty in class ImporterConfig

Column data

ImporterConfig::configureColumn() — Method in class ImporterConfig

Add column configuration

ImporterConfig::configureField() — Method in class ImporterConfig

Add field configuration

CacheTraitClass in namespace VuFind\Cache

Trait for caching data.

$ CacheTrait#cacheProperty in class CacheTrait

Cache for storing data temporarily (e.g. patron blocks with the ILS driver)

$ CacheTrait#cacheLifetimeProperty in class CacheTrait

Lifetime of cache (in seconds).

$ Manager#cacheSettingsProperty in class Manager

Settings used to generate cache objects.

$ Manager#cachesProperty in class Manager

Actual cache objects generated from settings.

Manager::createNoCache() — Method in class Manager

Create a "no-cache" setting.

Manager::createFileCache() — Method in class Manager

Add a file cache to the manager and ensure that necessary directory exists.

$ Image#cacheBasePathProperty in class Image

Base path of cache where image will be stored, e.g. /vufind/cache/

$ LaminasBase#captchaProperty in class LaminasBase

Laminas CAPTCHA object

$ LaminasBase#captchaHtmlInternalIdProperty in class LaminasBase

HTML input name for generated captcha

$ LaminasBase#captchaHtmlInputIdProperty in class LaminasBase

HTML input name for user input

CartClass in namespace VuFind

Cart Class

$ Cart#cookieManagerProperty in class Cart

Cookie manager

Cart::contains() — Method in class Cart

Does the cart contain the specified item?

CartFactoryClass in namespace VuFind

Cart factory.

$ AbstractChannelProvider#coverRouterProperty in class AbstractChannelProvider

Cover router

AbstractChannelProvider::configureSearchParams() — Method in class AbstractChannelProvider

Hook to configure search parameters before executing search.

$ AbstractILSChannelProvider#channelSizeProperty in class AbstractILSChannelProvider

Number of results to include in each channel.

$ AbstractILSChannelProvider#channelTitleProperty in class AbstractILSChannelProvider

Channel title (will be run through translator).

$ AlphaBrowse#channelSizeProperty in class AlphaBrowse

Number of results to include in each channel.

ChannelLoaderClass in namespace VuFind\ChannelProvider

Channel loader

$ ChannelLoader#cacheManagerProperty in class ChannelLoader

Cache manager

$ ChannelLoader#channelManagerProperty in class ChannelLoader

Channel manager

$ ChannelLoader#configProperty in class ChannelLoader

Channel configuration

ChannelLoaderFactoryClass in namespace VuFind\ChannelProvider

Factory for channel loader.

ChannelProviderInterfaceClass in namespace VuFind\ChannelProvider

Channel provider interface.

ChannelProviderInterface::configureSearchParams() — Method in class ChannelProviderInterface

Hook to configure search parameters before executing search.

Facets::configureSearchParams() — Method in class Facets

Hook to configure search parameters before executing search.

$ NewILSItems#channelTitleProperty in class NewILSItems

Channel title (will be run through translator).

$ Random#channelSizeProperty in class Random

Number of results to include in each channel.

$ RecentlyReturned#channelTitleProperty in class RecentlyReturned

Channel title (will be run through translator).

$ SimilarItems#channelSizeProperty in class SimilarItems

Number of results to include in each channel.

$ TrendingILSItems#channelTitleProperty in class TrendingILSItems

Channel title (will be run through translator).

$ AccountCapabilities#configProperty in class AccountCapabilities

VuFind configuration

PluginFactory::canCreate() — Method in class PluginFactory

Can we create a service for the specified name?

CacheDecoratorClass in namespace VuFind\Config\Reader

This class decorates a configuration file reader with caching support.

$ Upgrade#commentsProperty in class Upgrade

Comments parsed from configuration files

Upgrade::checkTheme() — Method in class Upgrade

Check for invalid theme setting.

Upgrade::checkAmazonConfig() — Method in class Upgrade

Add warnings if Amazon problems were found.

Upgrade::changeArrayKey() — Method in class Upgrade

Change an array key.

$ Writer#contentProperty in class Writer

Content of file

Writer::clear() — Method in class Writer

Remove a setting (convenience wrapper around set to null).

$ YamlReader#cacheNameProperty in class YamlReader

Cache directory name

$ YamlReader#cacheManagerProperty in class YamlReader

Cache manager

$ OpenLibrary#clientProperty in class OpenLibrary

HTTP client

Oracle::commit() — Method in class Oracle

Wrapper around oci_commit.

Oracle::clearError() — Method in class Oracle

Clear out internal error tracking details.

$ Relais#clientProperty in class Relais

HTTP client

$ Relais#configProperty in class Relais

Relais configuration

$ Wikipedia#clientProperty in class Wikipedia

HTTP client

Wikipedia::checkForRedirect() — Method in class Wikipedia

Check for redirection in the Wikipedia response

$ WorldCatUtils#configProperty in class WorldCatUtils

WorldCat configuration

$ WorldCatUtils#clientProperty in class WorldCatUtils

HTTP client

$ AbstractBase#configProperty in class AbstractBase
Configuration
$ BlockLoader#configManagerProperty in class BlockLoader

Config manager.

ChannelsClass in namespace VuFind\ContentBlock

Channels content block.

ChannelsFactoryClass in namespace VuFind\ContentBlock

Channels factory.

ContentBlockInterfaceClass in namespace VuFind\ContentBlock

Content block interface

$ FacetList#columnSizeProperty in class FacetList

Number of values to put in each column of results.

$ FacetList#configManagerProperty in class FacetList

Configuration manager

$ AbstractCover#cacheAllowedProperty in class AbstractCover

Are we allowed to cache images from this source?

Bokinfo::createHttpClient() — Method in class Bokinfo

Return a HTTP Client object

ContentCafeClass in namespace VuFind\Content\Covers

ContentCafe cover content loader.

ContentCafeFactoryClass in namespace VuFind\Content\Covers

ContentCafe cover loader factory

$ ObalkyKnihService#checkServersAvailabilityProperty in class ObalkyKnihService

Whether to check servers availability before API calls

ObalkyKnihService::createCacheKey() — Method in class ObalkyKnihService

Creates cache key based on ids

ObalkyKnihService::createLocalIdentifier() — Method in class ObalkyKnihService

Create identifier of local record

AbstractBase::createViewModel() — Method in class AbstractBase

Create a new ViewModel.

AbstractBase::createEmailViewModel() — Method in class AbstractBase

Create a new ViewModel to use as an email form.

AbstractBase::catalogLogin() — Method in class AbstractBase

Does the user have catalog credentials available? Returns associative array of patron data if so, otherwise forwards to appropriate login prompt and returns false. If there is an ILS exception, a flash message is added and a newly created ViewModel is returned.

AbstractBase::confirm() — Method in class AbstractBase

Confirm an action.

AbstractBase::commentsEnabled() — Method in class AbstractBase

Are comments enabled?

AbstractBase::clearFollowupUrl() — Method in class AbstractBase

Sometimes we need to unset the followup to trigger default behaviors

AbstractBase::captcha() — Method in class AbstractBase

Captcha plugin

AbstractRecord::createViewModel() — Method in class AbstractRecord

Create a new ViewModel.

AbstractRecord::citeAction() — Method in class AbstractRecord

Show citations for the current record.

AbstractSearch::createViewModel() — Method in class AbstractSearch

Create a new ViewModel.

AjaxResponseTrait::callAjaxMethod() — Method in class AjaxResponseTrait

Call an AJAX method and turn the result into a response.

$ AlmaController#configProperty in class AlmaController

Configuration from config.ini

$ AlmaController#configAlmaProperty in class AlmaController

Alma.ini config

AlmaController::createJsonResponse() — Method in class AlmaController

Create a HTTP response with JSON content and HTTP status codes that Alma takes as "answer" to its webhook calls.

AlmaController::checkPermission() — Method in class AlmaController

Helper function to check access permissions defined in permissions.ini.

AlmaController::checkMessageSignature() — Method in class AlmaController

Signing and hashing the body content of the Alma POST request with the webhook secret in Alma.ini. The calculated hash value must be the same as the 'X-Exl-Signature' in the request header. This is a security measure to be sure that the request comes from Alma.

$ BrowseController#configProperty in class BrowseController

VuFind configuration

$ BrowseController#currentActionProperty in class BrowseController

Current browse mode

BrowseController::createViewModel() — Method in class BrowseController

Create a new ViewModel.

CartControllerClass in namespace VuFind\Controller

Book Bag / Bulk Action Controller

CartControllerFactoryClass in namespace VuFind\Controller

Cart controller factory.

ChannelsControllerClass in namespace VuFind\Controller

Channels Class

ChannelsControllerFactoryClass in namespace VuFind\Controller

Channels controller factory.

CollectionControllerClass in namespace VuFind\Controller

Collection Controller

CollectionsControllerClass in namespace VuFind\Controller

Collections Controller

$ CollectionsController#configProperty in class CollectionsController

VuFind configuration

CombinedControllerClass in namespace VuFind\Controller

Redirects the user to the appropriate default VuFind action.

ConfirmControllerClass in namespace VuFind\Controller

Redirects the user to the appropriate VuFind action.

ConfirmController::confirmAction() — Method in class ConfirmController

Determines what elements are displayed on the home page based on whether the user is logged in.

ContentControllerClass in namespace VuFind\Controller

Controller for mostly static pages that doesn't fall under any particular function.

ContentController::contentAction() — Method in class ContentController

Default action if none provided

CoverControllerClass in namespace VuFind\Controller

Generates covers for book entries

CoverControllerFactoryClass in namespace VuFind\Controller

Cover controller factory.

ExternalAuthController::createEzproxyTicketUrl() — Method in class ExternalAuthController

Create a ticket login URL for EZproxy

CatchIlsExceptionsTraitClass in namespace VuFind\Controller\Feature

VuFind Action Feature Trait - Catch ILS exceptions from actions with an OnDispatch handler

ConfigPathTraitClass in namespace VuFind\Controller\Feature

VuFind Action Feature Trait - Configuration file path methods

$ HoldsController#csrfProperty in class HoldsController

CSRF validator

$ IndexController#configProperty in class IndexController

VuFind configuration

InstallController::checkBasicConfig() — Method in class InstallController

Check if basic configuration is taken care of.

InstallController::checkCache() — Method in class InstallController

Check if the cache directory is writable.

InstallController::checkDatabase() — Method in class InstallController

Check if the database is accessible.

InstallController::checkDependencies() — Method in class InstallController

Check for missing dependencies.

InstallController::checkILS() — Method in class InstallController

Check if ILS configuration is appropriate.

InstallController::checkSolr() — Method in class InstallController

Check if the Solr index is working.

InstallController::checkSecurity() — Method in class InstallController

Check if Security configuration is set.

InstallController::checkSslCerts() — Method in class InstallController

Check if SSL configuration is set properly.

LibraryCardsController::connectCardLoginAction() — Method in class LibraryCardsController

Redirects to authentication to connect a new library card

LibraryCardsController::connectCardAction() — Method in class LibraryCardsController

Connects a new library card for authenticated user

MyResearchController::catalogloginAction() — Method in class MyResearchController

Catalog Login Action

MyResearchController::confirmDeleteFavorite() — Method in class MyResearchController

Confirm a request to delete a favorite item.

MyResearchController::checkedoutAction() — Method in class MyResearchController

Send list of checked out books to view

MyResearchController::changeEmailAction() — Method in class MyResearchController

Handling submission of a new email for a user.

MyResearchController::changePasswordAction() — Method in class MyResearchController

Handling submission of a new password for a user.

$ OAuth2Controller#csrfProperty in class OAuth2Controller

CSRF validator

$ OAuth2Controller#claimExtractorProperty in class OAuth2Controller

Claim extractor

OAuth2Controller::convertOAuthServerExceptionToResponse() — Method in class OAuth2Controller

Convert an instance of OAuthServerException to a Laminas response.

$ OAuth2ControllerFactory#containerProperty in class OAuth2ControllerFactory

Service manager

$ OAuth2ControllerFactory#claimExtractorProperty in class OAuth2ControllerFactory

Claim extractor

OAuth2ControllerFactory::createAuthCodeGrant() — Method in class OAuth2ControllerFactory

Create an auth code grant

OAuth2ControllerFactory::createRefreshTokenGrant() — Method in class OAuth2ControllerFactory

Create a refresh token grant

$ OverdriveController#connectorProperty in class OverdriveController

Overdrive Connector

CaptchaClass in namespace VuFind\Controller\Plugin

Action helper to manage Captcha fields

$ Captcha#captchasProperty in class Captcha

Captcha services

CaptchaFactoryClass in namespace VuFind\Controller\Plugin

Factory for Captcha controller plugin.

DbUpgrade::createMissingTables() — Method in class DbUpgrade

Create missing tables based on the output of getMissingTables().

DbUpgrade::compareConstraints() — Method in class DbUpgrade

Compare expected vs. actual constraints and return an array of SQL clauses required to create the missing constraints.

DbUpgrade::compareConstraintActions() — Method in class DbUpgrade

Compare expected vs. actual constraint actions and return an array of SQL clauses required to create the modified constraints.

DbUpgrade::constraintIsMissing() — Method in class DbUpgrade

Support method for getModifiedConstraints() -- check if the current constraint is in the missing constraint list so we can avoid modifying something that does not exist.

DbUpgrade::columnIsMissing() — Method in class DbUpgrade

Support method for getModifiedColumns() -- check if the current column is in the missing column list so we can avoid modifying something that does not exist.

DbUpgrade::createMissingColumns() — Method in class DbUpgrade

Create missing columns based on the output of getMissingColumns().

DbUpgrade::createMissingConstraints() — Method in class DbUpgrade

Create missing constraints based on the output of getMissingConstraints().

$ Favorites#cacheProperty in class Favorites

Record cache

Favorites::cacheBatch() — Method in class Favorites

Support method for saveBulk() -- save a batch of records to the cache.

Followup::clear() — Method in class Followup

Clear an element of the stored followup information.

Holds::cancelHolds() — Method in class Holds

Process cancellation requests.

ILLRequests::cancelILLRequests() — Method in class ILLRequests

Process cancel request.

$ IlsRecords#configProperty in class IlsRecords

VuFind configuration

IlsRecords::collectRequestStats() — Method in class IlsRecords

Collect up to date status information for ajax account notifications.

$ NewItems#configProperty in class NewItems
Configuration
Permission::check() — Method in class Permission

Check if a permission is denied; if so, throw an exception or return an error response as configured in permissionBehavior.ini.

StorageRetrievalRequests::cancelStorageRetrievalRequests() — Method in class StorageRetrievalRequests

Process cancel request.

SearchController::collectionfacetlistAction() — Method in class SearchController

Show facet list for Solr-driven collections.

$ UpgradeController#cookieProperty in class UpgradeController

Cookie container

ContainerClass in namespace VuFind\Cookie

Class for treating a set of cookies as an object (inspired by \Laminas\Session\Container).

CookieManagerClass in namespace VuFind\Cookie

Cookie Manager

$ CookieManager#cookiesProperty in class CookieManager

Cookie array to work with

CookieManager::clear() — Method in class CookieManager

Clear a cookie.

CookieManagerFactoryClass in namespace VuFind\Cookie

Cookie Manager factory.

CachingProxyClass in namespace VuFind\Cover

Caching Proxy for Cover Images

$ CachingProxy#clientProperty in class CachingProxy

HTTP client

$ CachingProxy#cacheProperty in class CachingProxy

Base directory for cache

CachingProxyFactoryClass in namespace VuFind\Cover

Cover caching proxy factory.

AbstractBackgroundLayer::createSeed() — Method in class AbstractBackgroundLayer

Generates a dynamic cover image from elements of the book

$ AbstractLayer#colorMapProperty in class AbstractLayer

Mapping of color names to RGB values.

GridBackground::createPattern() — Method in class GridBackground

Turn number into pattern

$ Loader#configProperty in class Loader

VuFind configuration settings

Loader::convertNonJpeg() — Method in class Loader

Support method for validateAndMoveTempFile -- convert non-JPEG image data to a JPEG file.

$ Router#coverLoaderProperty in class Router

Cover loader

$ AdapterFactory#configProperty in class AdapterFactory

VuFind configuration

ChangeTrackerClass in namespace VuFind\Db\Row

Row Definition for change_tracker

CommentsClass in namespace VuFind\Db\Row

Row Definition for comments

$ Search#createdProperty in class Search
$ Search#checksumProperty in class Search
$ User#configProperty in class User

VuFind configuration

$ User#cat_idProperty in class User
$ User#cat_usernameProperty in class User
$ User#cat_passwordProperty in class User
$ User#cat_pass_encProperty in class User
$ User#collegeProperty in class User
$ User#createdProperty in class User
User::clearCredentials() — Method in class User

Reset ILS login credentials.

User::changeHomeLibrary() — Method in class User

Change home library.

User::checkEmailVerified() — Method in class User

Check whether the email address has been verified yet.

$ UserCard#card_nameProperty in class UserCard
$ UserCard#cat_usernameProperty in class UserCard
$ UserCard#cat_passwordProperty in class UserCard
$ UserCard#cat_pass_encProperty in class UserCard
$ UserCard#createdProperty in class UserCard
$ UserList#createdProperty in class UserList
CaseSensitiveTagsFactoryClass in namespace VuFind\Db\Table

Shared Tags / ResourceTags table gateway factory.

ChangeTrackerClass in namespace VuFind\Db\Table

Table Definition for change_tracker

CommentsClass in namespace VuFind\Db\Table

Table Definition for comments

Gateway::createRow() — Method in class Gateway

Create a new row.

Record::cleanup() — Method in class Record

Clean up orphaned entries (i.e. entries that are not in favorites anymore)

$ ResourceTags#caseSensitiveProperty in class ResourceTags

Are tags case sensitive?

ResourceTags::createLink() — Method in class ResourceTags

Look up a row for the specified resource.

ResourceTags::checkForTags() — Method in class ResourceTags

Check whether or not the specified tags are present in the table.

$ Tags#caseSensitiveProperty in class Tags

Are tags case sensitive?

$ User#configProperty in class User

VuFind configuration

User::createRowForUsername() — Method in class User

Create a row for the specified username.

UserResource::createOrUpdateLink() — Method in class UserResource

Create link if one does not exist; update notes if one does.

$ OverdriveConnector#clientProperty in class OverdriveConnector

HTTP Client

$ OverdriveConnector#cacheProperty in class OverdriveConnector

Cache for storing ILS data temporarily (e.g. patron blocks)

OverdriveConnector::cancelHold() — Method in class OverdriveConnector

Cancel Hold Cancel and existing Overdrive Hold

OverdriveConnector::callUrl() — Method in class OverdriveConnector

Call a URL on the API

OverdriveConnector::connectToAPI() — Method in class OverdriveConnector

Connect to API

OverdriveConnector::callPatronUrl() — Method in class OverdriveConnector

Call a Patron URL on the API

OverdriveConnector::connectToPatronAPI() — Method in class OverdriveConnector

Connect to Patron API

$ BrowZine#configProperty in class BrowZine

Configuration options

Unpaywall::callApi() — Method in class Unpaywall

Takes a DOI and do an API call to Unpaywall service

$ Feed#calledProperty in class Feed

Set to TRUE if a rendering method actually renders something. This is used to prevent premature appending of a XML namespace declaration until an element which requires it is actually appended.

$ AbstractConfig#configLoaderProperty in class AbstractConfig

Configuration loader

$ AbstractBase#configProperty in class AbstractBase

Driver configuration

ConfigurationBasedClass in namespace VuFind\Hierarchy\Driver

Configuration-Based Hierarchy Driver

ConfigurationBasedFactoryClass in namespace VuFind\Hierarchy\Driver

Hierarchy Driver Factory Class

$ AbstractBase#childMapProperty in class AbstractBase

Child data map from index

$ AbstractBase#collectionTypeProperty in class AbstractBase

Collection mode

$ AbstractBase#countProperty in class AbstractBase

How many nodes have we formatted?

$ AbstractBase#collectionRouteProperty in class AbstractBase

Collection page route.

$ Search2#collectionRouteProperty in class Search2

Collection page route.

$ Search2#cachePrefixProperty in class Search2

Hierarchy cache file prefix.

$ Solr#cacheDirProperty in class Solr

Cache directory

$ Solr#cachePrefixProperty in class Solr

Hierarchy cache file prefix.

$ JSTree#collectionsEnabledProperty in class JSTree

Whether the collections functionality is enabled

CachingDownloaderClass in namespace VuFind\Http

Caching downloader.

$ CachingDownloader#cacheManagerProperty in class CachingDownloader

CacheManager to update caches if necessary.

$ CachingDownloader#cacheProperty in class CachingDownloader

Cache to use for downloads

$ CachingDownloader#cacheIdProperty in class CachingDownloader

Cache ID to use for downloads

$ CachingDownloader#cacheOptionsProperty in class CachingDownloader

Stored client options for cache key generation.

CachingDownloaderAwareInterfaceClass in namespace VuFind\Http

Lightweight caching downloader aware marker interface.

CachingDownloaderAwareTraitClass in namespace VuFind\Http

Lightweight caching downloader aware marker trait.

$ CachingDownloaderAwareTrait#cachingDownloaderProperty in class CachingDownloaderAwareTrait

Caching downloader

CachingDownloaderFactoryClass in namespace VuFind\Http

Caching downloader factory.

Request::cleanup() — Method in class Request

Clean up a parameter

ExtendedIniNormalizer::checkFileFormat() — Method in class ExtendedIniNormalizer

Check that the file to process is a valid language file.

$ Sorter#collatorProperty in class Sorter

Intl Collator

Sorter::compare() — Method in class Sorter

Compare function

Sorter::collatorNatsort() — Method in class Sorter

Function to actually do natural sorting

SorterInterface::compare() — Method in class SorterInterface

Compare function

ExtendedIni::checkAndMarkLoadedFile() — Method in class ExtendedIni

Check if a file has already been loaded; mark it loaded if it is not already.

ConnectionClass in namespace VuFind\ILS

Catalog Connection Class

$ Connection#configProperty in class Connection

ILS configuration

$ Connection#configReaderProperty in class Connection

Configuration loader

Connection::checkFunction() — Method in class Connection

Check Function

Connection::checkMethodHolds() — Method in class Connection

Check Holds

Connection::checkMethodcancelHolds() — Method in class Connection

Check Cancel Holds

Connection::checkMethodRenewals() — Method in class Connection

Check Renewals

Connection::checkMethodStorageRetrievalRequests() — Method in class Connection

Check Storage Retrieval Request

Connection::checkMethodcancelStorageRetrievalRequests() — Method in class Connection

Check Cancel Storage Retrieval Requests

Connection::checkMethodILLRequests() — Method in class Connection

Check ILL Request

Connection::checkMethodcancelILLRequests() — Method in class Connection

Check Cancel ILL Requests

Connection::checkMethodchangePassword() — Method in class Connection

Check Password Change

Connection::checkMethodgetMyTransactions() — Method in class Connection

Check Current Loans

Connection::checkMethodgetMyTransactionHistory() — Method in class Connection

Check Historic Loans

Connection::checkMethodpatronLogin() — Method in class Connection

Check Patron login

Connection::checkRequestIsValid() — Method in class Connection

Check Request is Valid

Connection::checkStorageRetrievalRequestIsValid() — Method in class Connection

Check Storage Retrieval Request is Valid

Connection::checkILLRequestIsValid() — Method in class Connection

Check ILL Request is Valid

Connection::checkCapability() — Method in class Connection

Check driver capability -- return true if the driver supports the specified method; false otherwise.

ConnectionFactoryClass in namespace VuFind\ILS

ILS connection factory

$ AbstractBase#configProperty in class AbstractBase

Driver configuration

$ Aleph#cacheManagerProperty in class Aleph

Cache manager

Aleph::cancelHolds() — Method in class Aleph

Cancel Holds

$ AlephTranslator#charsetProperty in class AlephTranslator

Character set

$ Alma#configLoaderProperty in class Alma

Configuration loader

Alma::checkRequestIsValid() — Method in class Alma

Check if request is valid

Alma::createAlmaUser() — Method in class Alma

Create a user in Alma via API call

Alma::cancelHolds() — Method in class Alma

Cancel hold requests.

$ DAIA#contentTypesResponseProperty in class DAIA

Acceptable ContentTypes delivered by DAIA server in HTTP header

$ DAIA#contentTypesRequestProperty in class DAIA

ContentTypes to use in DAIA HTTP requests in HTTP header

DAIA::convertDate() — Method in class DAIA

Support method to handle date uniformly

DAIA::convertDatetime() — Method in class DAIA

Support method to handle datetime uniformly

DAIA::convertDaiaXmlToJson() — Method in class DAIA

Converts a DAIA XML response to an array identical with a DAIA JSON response for the sent query.

DAIA::checkIsRecallable() — Method in class DAIA

Helper function to determine if item is recallable.

DAIA::checkIsStorageRetrievalRequest() — Method in class DAIA

Helper function to determine if the item is available as storage retrieval.

$ Demo#catalogIdProperty in class Demo

Catalog ID used to distinquish between multiple Demo driver instances with the MultiBackend driver

$ Demo#coursesProperty in class Demo

Courses for use in course reserves.

Demo::checkIntermittentFailure() — Method in class Demo

Should we simulate a system failure?

Demo::checkRenewBlock() — Method in class Demo

Are renewals blocked?

Demo::createRequestList() — Method in class Demo

Generate a list of holds, storage retrieval requests or ILL requests.

Demo::calculateDueStatus() — Method in class Demo

Calculate the due status for a due date.

Demo::cancelHolds() — Method in class Demo

Cancel Holds

Demo::cancelStorageRetrievalRequests() — Method in class Demo

Cancel Storage Retrieval Request

Demo::checkRequestIsValid() — Method in class Demo

Check if hold or recall available

Demo::checkStorageRetrievalRequestIsValid() — Method in class Demo

Check if storage retrieval request available

Demo::checkILLRequestIsValid() — Method in class Demo

Check if ILL request available

Demo::cancelILLRequests() — Method in class Demo

Cancel ILL Request

Demo::changePassword() — Method in class Demo

Change Password

Folio::checkTenantToken() — Method in class Folio

Check if our token is still valid

Folio::chooseCallNumber() — Method in class Folio

Choose a call number and callnumber prefix.

Folio::cancelHolds() — Method in class Folio

Cancel Holds

GeniePlus::callApiWithToken() — Method in class GeniePlus

Call the API, with an access token added to the headers; renew token as needed.

Horizon::checkHzVersion() — Method in class Horizon

Check Horizon Version

HorizonXMLAPI::checkRequestIsValid() — Method in class HorizonXMLAPI

Check if Request is Valid

HorizonXMLAPI::cancelRequest() — Method in class HorizonXMLAPI

Cancel Request

HorizonXMLAPI::cancelHolds() — Method in class HorizonXMLAPI

Cancel Holds

KohaILSDI::cancelHolds() — Method in class KohaILSDI

Cancel Holds

KohaILSDI::changePassword() — Method in class KohaILSDI

Change Password

$ KohaRest#currencyFormatterProperty in class KohaRest

Currency formatter

KohaRest::cancelHolds() — Method in class KohaRest

Cancel Holds

KohaRest::checkRequestIsValid() — Method in class KohaRest

Check if request is valid

KohaRest::cancelStorageRetrievalRequests() — Method in class KohaRest

Cancel Storage Retrieval Requests (article requests)

KohaRest::checkStorageRetrievalRequestIsValid() — Method in class KohaRest

Check if storage retrieval request is valid

KohaRest::changePassword() — Method in class KohaRest

Change Password

KohaRest::createHttpClient() — Method in class KohaRest

Create a HTTP client

KohaRest::convertDate() — Method in class KohaRest

Convert a date to display format

$ MultiBackend#configProperty in class MultiBackend

The array of driver configuration options.

$ MultiBackend#configLoaderProperty in class MultiBackend

Configuration loader

MultiBackend::checkRequestIsValid() — Method in class MultiBackend

Check whether a hold or recall request is valid

MultiBackend::checkStorageRetrievalRequestIsValid() — Method in class MultiBackend

Check whether a storage retrieval request is valid

MultiBackend::checkILLRequestIsValid() — Method in class MultiBackend

Check whether an ILL request is valid

MultiBackend::createDriver() — Method in class MultiBackend

Create a driver for the given source.

MultiBackend::callMethodIfSupported() — Method in class MultiBackend

Check that the requested method is supported and call it.

PAIA::cancelHolds() — Method in class PAIA

This method cancels a list of holds for a specific patron.

PAIA::changePassword() — Method in class PAIA

Public Function which changes the password in the library system (not supported prior to VuFind 2.4)

PAIA::cancelStorageRetrievalRequests() — Method in class PAIA

Cancel Storage Retrieval Request

PAIA::checkILLRequestIsValid() — Method in class PAIA

Check if ILL request available

PAIA::cancelILLRequests() — Method in class PAIA

Cancel ILL Request

PAIA::checkStorageRetrievalRequestIsValid() — Method in class PAIA

Check if storage retrieval request available

PAIA::checkRequestIsValid() — Method in class PAIA

Check if hold or recall available

Polaris::cancelHolds() — Method in class Polaris

Cancel Holds

Sierra::createFullId() — Method in class Sierra

Converts the record numbers in the Postgres database to the record numbers in VuFind

$ SierraRest#configProperty in class SierraRest

Driver configuration

$ SierraRest#checkItemsExistProperty in class SierraRest

Whether to check that items exist when placing a hold

$ SierraRest#checkFreezabilityProperty in class SierraRest

Whether to check hold freezability up front. Not enabled by default since Sierra versions prior to 5.6 return holds slowly if canFreeze is requested.

SierraRest::cancelHolds() — Method in class SierraRest

Cancel Holds

SierraRest::checkRequestIsValid() — Method in class SierraRest

Check if request is valid

SierraRest::changePassword() — Method in class SierraRest

Change Password

SierraRest::createHttpClient() — Method in class SierraRest

Create a HTTP client

$ Symphony#cacheManagerProperty in class Symphony

Cache manager

Symphony::checkSymwsVersion() — Method in class Symphony

Check the SymWS version, and throw an Exception if it's too old.

Symphony::cancelHolds() — Method in class Symphony

Cancel Holds

Unicorn::cancelHolds() — Method in class Unicorn

Cancel Holds

Unicorn::calculateRecallDueDate() — Method in class Unicorn

Given the date recalled, calculate the new due date based on circulation policy.

Virtua::checkHoldAllowed() — Method in class Virtua

Check if this patron is allowed to place a request.

Virtua::cancelHolds() — Method in class Virtua

Cancel Holds

Virtua::cancelHold() — Method in class Virtua

Cancel a request in virtua.

$ VoyagerRestful#callSlipCheckLimitProperty in class VoyagerRestful

The maximum number of call slips to check at a time (0 = no limit)

$ VoyagerRestful#cookiesProperty in class VoyagerRestful

Web Services cookies. Required for at least renewals (for JSESSIONID) as documented at http://www.exlibrisgroup.org/display/VoyagerOI/Renew

$ VoyagerRestful#checkItemsExistProperty in class VoyagerRestful

Whether to check that items exist when placing a hold or recall request

$ VoyagerRestful#checkItemsNotAvailableProperty in class VoyagerRestful

Whether to check that items are not available when placing a hold or recall request

$ VoyagerRestful#checkLoansProperty in class VoyagerRestful

Whether to check that the user doesn't already have the record on loan when placing a hold or recall request

VoyagerRestful::checkRequestIsValid() — Method in class VoyagerRestful

Check if request is valid

VoyagerRestful::checkStorageRetrievalRequestIsValid() — Method in class VoyagerRestful

Check if storage retrieval request is valid

VoyagerRestful::checkAccountBlocks() — Method in class VoyagerRestful

Check Account Blocks

VoyagerRestful::checkItemRequests() — Method in class VoyagerRestful

Check Item Requests

VoyagerRestful::cancelHolds() — Method in class VoyagerRestful

Cancel Holds

VoyagerRestful::cancelStorageRetrievalRequests() — Method in class VoyagerRestful

Cancel Storage Retrieval Requests (Call Slips)

VoyagerRestful::checkILLRequestIsValid() — Method in class VoyagerRestful

Check if ILL Request is valid

VoyagerRestful::cancelILLRequests() — Method in class VoyagerRestful

Cancel ILL (UB) Requests

VoyagerRestful::changePassword() — Method in class VoyagerRestful

Change Password

$ XCNCIP2#consortiumProperty in class XCNCIP2

Is this a consortium? Default: false

XCNCIP2::checkStorageRetrievalRequestIsValid() — Method in class XCNCIP2

Check if storage retrieval request available

XCNCIP2::cancelHolds() — Method in class XCNCIP2

Cancel Holds

XCNCIP2::cancelStorageRetrievalRequests() — Method in class XCNCIP2

Cancel Storage Retrieval Requests (Call Slips)

XCNCIP2::checkResponseForError() — Method in class XCNCIP2

Throw an exception if an NCIP error is found

XCNCIP2::convertDateOrTime() — Method in class XCNCIP2

Convert datetime to display format

XCNCIP2::checkRequestType() — Method in class XCNCIP2

Is request of desired type?

$ HoldSettings#configProperty in class HoldSettings

ILS configuration

$ Holds#catalogProperty in class Holds

Catalog connection object

$ Holds#configProperty in class Holds

VuFind configuration

$ TitleHolds#catalogProperty in class TitleHolds

Catalog connection object

$ TitleHolds#configProperty in class TitleHolds

VuFind configuration

TitleHolds::checkOverrideMode() — Method in class TitleHolds

Support method for getHold to determine if we should override the configured holds mode.

$ ImageLoader#contentTypeProperty in class ImageLoader

Content type of data in $image property

$ ImageLoader#configuredFailImageProperty in class ImageLoader

User-configured image to load from theme on error.

LoggerFactory::configureLogger() — Method in class LoggerFactory

Set configuration

$ Post#clientProperty in class Post

Pre-configured http client

$ Post#contentTypeProperty in class Post

Content type

$ Slack#channelProperty in class Slack

The slack channel that should receive messages.

Mailer::convertToAddressList() — Method in class Mailer

Convert the given addresses to an AddressList object

$ Server#coreProperty in class Server

What Solr core are we serving up?

Server::createResponse() — Method in class Server

Create an OAI-PMH response (shared support method used by various response-specific methods).

ClientEntityClass in namespace VuFind\OAuth2\Entity

OAuth2 client entity implementation.

ClientRepositoryClass in namespace VuFind\OAuth2\Repository

OAuth2 client repository implementation.

$ AbstractFacets#configLoaderProperty in class AbstractFacets

Configuration loader

AbstractSummonRecommend::configureSummonResults() — Method in class AbstractSummonRecommend

If we have to create a new Summon results object, this method is used to configure it with appropriate settings.

$ AuthorInfo#clientProperty in class AuthorInfo

HTTP client

CatalogResultsClass in namespace VuFind\Recommend

CatalogResults Recommendations Module

ChannelsClass in namespace VuFind\Recommend

Channels Recommendations Module

CollectionSideFacetsClass in namespace VuFind\Recommend

CollectionSideFacets Recommendations Module

CollectionSideFacetsFactoryClass in namespace VuFind\Recommend

CollectionSideFacets recommendation module factory.

$ DPLATerms#clientProperty in class DPLATerms

VuFind HTTP Client

$ DPLATerms#collapsedProperty in class DPLATerms

Setting of initial collapsedness

$ ExpandFacets#configLoaderProperty in class ExpandFacets

Configuration loader

$ Libraryh3lp#chatIdProperty in class Libraryh3lp

Chat identifier

$ RecommendLinks#configLoaderProperty in class RecommendLinks

Configuration loader

$ SideFacets#checkboxFacetsProperty in class SideFacets

Checkbox facet configuration

$ SideFacets#collapsedFacetsProperty in class SideFacets

Collapsed facet setting

SummonTopics::configureSummonResults() — Method in class SummonTopics

If we have to create a new Summon results object, this method is used to configure it with appropriate settings.

SwitchQuery::checkFuzzy() — Method in class SwitchQuery

Will a fuzzy search help?

SwitchQuery::checkLowercaseBools() — Method in class SwitchQuery

Does the query contain lowercase boolean operators that should be uppercased?

SwitchQuery::checkUnwantedBools() — Method in class SwitchQuery

Does the query contain terms that are being treated as boolean operators, perhaps unintentionally?

SwitchQuery::checkUnwantedQuotes() — Method in class SwitchQuery

Would removing quotes help?

SwitchQuery::checkWildcard() — Method in class SwitchQuery

Will adding a wildcard help?

SwitchQuery::checkTruncatechar() — Method in class SwitchQuery

Broaden search by truncating one character (e.g. call number)

$ EIT#controlInfoProperty in class EIT

Reference to controlInfo section of fields, for readability

$ SolrDefault#containerLinkingProperty in class SolrDefault

Should we use hierarchy fields for simple container-child records linking?

$ SolrOverdrive#connectorProperty in class SolrOverdrive

Overdrive Connector

$ SolrOverdrive#configProperty in class SolrOverdrive

Overdrive Configuration Object

CollectionHierarchyTreeClass in namespace VuFind\RecordTab

HierarchyTree tab

CollectionHierarchyTreeFactoryClass in namespace VuFind\RecordTab

Factory for building the CollectionHierarchyTree tab.

CollectionListClass in namespace VuFind\RecordTab

Collection list tab

CollectionListFactoryClass in namespace VuFind\RecordTab

Factory for building the CollectionList tab.

ComponentPartsClass in namespace VuFind\RecordTab

Component parts display tab

ComponentPartsFactoryClass in namespace VuFind\RecordTab

Factory for building the ComponentParts tab.

$ HierarchyTree#configProperty in class HierarchyTree
Configuration
$ HoldingsILS#catalogProperty in class HoldingsILS

ILS connection (or null if not applicable)

$ Preview#configProperty in class Preview
Configuration
$ TabManager#contextSettingsProperty in class TabManager

Settings for different tab contexts.

$ TabManager#configProperty in class TabManager

Tab configurations

$ TabManager#configManagerProperty in class TabManager

Configuration plugin manager

$ TabManager#contextProperty in class TabManager

Current active context (defaults to 'record')

$ Versions#configProperty in class Versions

Main configuration

CacheClass in namespace VuFind\Record

Record Cache

$ Cache#cacheConfigProperty in class Cache

RecordCache.ini contents

$ Cache#cachableSourcesProperty in class Cache

Record sources which may be cached.

Cache::createOrUpdate() — Method in class Cache

Create a new or update an existing cache entry

CacheFactoryClass in namespace VuFind\Record

Record cache factory.

ChecklistClass in namespace VuFind\Record

Checklist class (used for checking off a list of values)

$ Checklist#checkedProperty in class Checklist

Checked values

Checklist::check() — Method in class Checklist

Check off a value, returning true if the value was found in the unchecked list and false if it was not.

$ Router#configProperty in class Router

VuFind configuration

$ Bookplate#configProperty in class Bookplate

Bookplate config

$ Bookplate#configLoaderProperty in class Bookplate

Configuration loader

ChannelsClass in namespace VuFind\Related

Related Records: Link to Channels

CsvReaderClass in namespace VuFind\Reserves

Support class to build reserves data from CSV file(s).

$ CsvReader#coursesProperty in class CsvReader

Course data loaded from files

ConnectionClass in namespace VuFind\Resolver

Resolver Connection Class

$ Connection#cachePathProperty in class Connection

The path to the resolver cache, if any (empty string for no caching)

Alma::cleanupText() — Method in class Alma

Clean up textual information

$ DynamicRoleProvider#configProperty in class DynamicRoleProvider

Configuration for determining permissions.

$ PermissionDeniedManager#configProperty in class PermissionDeniedManager

List config

$ PermissionManager#configProperty in class PermissionManager

List config

ServerParam::checkServerParam() — Method in class ServerParam

Check if a server param matches the option.

ClickatellClass in namespace VuFind\SMS

Class for text messaging via Clickatell's HTTP API

$ Clickatell#clientProperty in class Clickatell

HTTP client

$ Mailer#carriersProperty in class Mailer

Default carriers, usually overridden by contents of web/conf/sms.ini.

$ FacetCache#cacheManagerProperty in class FacetCache

Cache manager

$ Options#configLoaderProperty in class Options

Configuration loader

Options::configureAutocomplete() — Method in class Options

Configure autocomplete preferences from an .ini file.

$ Params#checkboxFacetsProperty in class Params

Checkbox facet configuration

$ Params#configLoaderProperty in class Params

Config loader

Params::convertToAdvancedSearch() — Method in class Params

Convert a basic query into an advanced query:

$ Options#commonLimitersProperty in class Options

Limiters to display on the basic search screen

$ Options#commonExpandersProperty in class Options

Expanders to display on the basic search screen

$ Params#checkboxFacetsAugmentedProperty in class Params

A flag indicating whether limiters and expanders have been added to the checkbox facets. Used to defer adding them (and accessing the API) until necessary.

Params::createBackendFilterParameters() — Method in class Params

Set up filters based on VuFind settings.

AbstractBackendFactory::createHttpClient() — Method in class AbstractBackendFactory

Create HTTP Client

AbstractBackendFactory::createConnectorCache() — Method in class AbstractBackendFactory

Create cache for the connector if enabled in configuration

$ AbstractSolrBackendFactory#configProperty in class AbstractSolrBackendFactory

VuFind configuration reader

$ AbstractSolrBackendFactory#connectorClassProperty in class AbstractSolrBackendFactory

Solr connector class

AbstractSolrBackendFactory::createBackend() — Method in class AbstractSolrBackendFactory

Create the SOLR backend.

AbstractSolrBackendFactory::createListeners() — Method in class AbstractSolrBackendFactory

Create listeners.

AbstractSolrBackendFactory::createConnector() — Method in class AbstractSolrBackendFactory

Create the SOLR connector.

AbstractSolrBackendFactory::createQueryBuilder() — Method in class AbstractSolrBackendFactory

Create the query builder.

AbstractSolrBackendFactory::createLuceneSyntaxHelper() — Method in class AbstractSolrBackendFactory

Create Lucene syntax helper.

AbstractSolrBackendFactory::createSimilarBuilder() — Method in class AbstractSolrBackendFactory

Create the similar records query builder.

AbstractSolrBackendFactory::createRecordCollectionFactory() — Method in class AbstractSolrBackendFactory

Create the record collection factory.

$ BlenderBackendFactory#containerProperty in class BlenderBackendFactory

Service manager.

$ BlenderBackendFactory#configProperty in class BlenderBackendFactory

VuFind configuration reader

BrowZineBackendFactory::createBackend() — Method in class BrowZineBackendFactory

Create the Primo Central backend.

BrowZineBackendFactory::createConnector() — Method in class BrowZineBackendFactory

Create the Primo Central connector.

BrowZineBackendFactory::createQueryBuilder() — Method in class BrowZineBackendFactory

Create the Primo query builder.

BrowZineBackendFactory::createRecordCollectionFactory() — Method in class BrowZineBackendFactory

Create the record collection factory

$ EITBackendFactory#configProperty in class EITBackendFactory

VuFind configuration

EITBackendFactory::createBackend() — Method in class EITBackendFactory

Create the EIT backend.

EITBackendFactory::createConnector() — Method in class EITBackendFactory

Create the EIT connector.

EITBackendFactory::createQueryBuilder() — Method in class EITBackendFactory

Create the EIT query builder.

EITBackendFactory::createRecordCollectionFactory() — Method in class EITBackendFactory

Create the record collection factory

EdsBackendFactory::createBackend() — Method in class EdsBackendFactory

Create the EDS backend.

EdsBackendFactory::createConnector() — Method in class EdsBackendFactory

Create the EDS connector.

EdsBackendFactory::createQueryBuilder() — Method in class EdsBackendFactory

Create the EDS query builder.

EdsBackendFactory::createRecordCollectionFactory() — Method in class EdsBackendFactory

Create the record collection factory

EdsBackendFactory::createListeners() — Method in class EdsBackendFactory

Create listeners.

LibGuidesBackendFactory::createBackend() — Method in class LibGuidesBackendFactory

Create the LibGuides backend.

LibGuidesBackendFactory::createConnector() — Method in class LibGuidesBackendFactory

Create the LibGuides connector.

LibGuidesBackendFactory::createQueryBuilder() — Method in class LibGuidesBackendFactory

Create the LibGuides query builder.

LibGuidesBackendFactory::createRecordCollectionFactory() — Method in class LibGuidesBackendFactory

Create the record collection factory

$ Pazpar2BackendFactory#configProperty in class Pazpar2BackendFactory

VuFind configuration

Pazpar2BackendFactory::createBackend() — Method in class Pazpar2BackendFactory

Create the Pazpar2 backend.

Pazpar2BackendFactory::createConnector() — Method in class Pazpar2BackendFactory

Create the Pazpar2 connector.

Pazpar2BackendFactory::createQueryBuilder() — Method in class Pazpar2BackendFactory

Create the Pazpar2 query builder.

Pazpar2BackendFactory::createRecordCollectionFactory() — Method in class Pazpar2BackendFactory

Create the record collection factory

$ PrimoBackendFactory#connectorClassProperty in class PrimoBackendFactory

Primo connector class

PrimoBackendFactory::createBackend() — Method in class PrimoBackendFactory

Create the Primo Central backend.

PrimoBackendFactory::createListeners() — Method in class PrimoBackendFactory

Create listeners.

PrimoBackendFactory::createConnector() — Method in class PrimoBackendFactory

Create the Primo Central connector.

PrimoBackendFactory::createQueryBuilder() — Method in class PrimoBackendFactory

Create the Primo query builder.

PrimoBackendFactory::createRecordCollectionFactory() — Method in class PrimoBackendFactory

Create the record collection factory

$ SummonBackendFactory#configProperty in class SummonBackendFactory

VuFind configuration

SummonBackendFactory::createBackend() — Method in class SummonBackendFactory

Create the Summon backend.

SummonBackendFactory::createConnector() — Method in class SummonBackendFactory

Create the Summon connector.

SummonBackendFactory::createQueryBuilder() — Method in class SummonBackendFactory

Create the Summon query builder.

SummonBackendFactory::createRecordCollectionFactory() — Method in class SummonBackendFactory

Create the record collection factory

$ WorldCatBackendFactory#configProperty in class WorldCatBackendFactory

VuFind configuration

WorldCatBackendFactory::createBackend() — Method in class WorldCatBackendFactory

Create the WorldCat backend.

WorldCatBackendFactory::createConnector() — Method in class WorldCatBackendFactory

Create the WorldCat connector.

WorldCatBackendFactory::createQueryBuilder() — Method in class WorldCatBackendFactory

Create the WorldCat query builder.

WorldCatBackendFactory::createRecordCollectionFactory() — Method in class WorldCatBackendFactory

Create the record collection factory

$ History#configProperty in class History

VuFind configuration

$ Minified#clProperty in class Minified

Search class

$ NormalizedSearch#checksumProperty in class NormalizedSearch

Checksum of normalized search URL

PrimoPermissionHandler::checkConfig() — Method in class PrimoPermissionHandler

Checks the config file section for validity

PrimoPermissionHandler::checkLegacySettings() — Method in class PrimoPermissionHandler

Legacy settings support

PrimoPermissionHandler::checkPermission() — Method in class PrimoPermissionHandler

Checks, if a rule is granted

$ RecommendListener#configProperty in class RecommendListener

Recommendation configuration.

$ Params#collectionFieldProperty in class Params

The field which defines something as being a collection this is usually either hierarchy_parent_id or hierarchy_top_id

$ Params#collectionIDProperty in class Params

The ID of the collection being searched

CustomFilterListenerClass in namespace VuFind\Search\Solr

Solr custom filter listener.

$ DefaultParametersListener#contextMapProperty in class DefaultParametersListener

Mapping from search methods to contexts

HierarchicalFacetHelper::createFacetItem() — Method in class HierarchicalFacetHelper

Create an item for the hierarchical facet array

$ Results#cursorMarkProperty in class Results

CursorMark used for deep paging (e.g. OAI-PMH Server).

Params::createBackendFilterParameters() — Method in class Params

Set up filters based on VuFind settings.

$ UrlQueryHelper#configProperty in class UrlQueryHelper

Configuration for this helper.

UrlQueryHelper::clearSearchQueryParams() — Method in class UrlQueryHelper

Reset search-related parameters in the internal array.

CspHeaderGeneratorClass in namespace VuFind\Security

VuFind class for generating Content Security Policy http headers

$ CspHeaderGenerator#configProperty in class CspHeaderGenerator

Configuration for generator from contensecuritypolicy.ini

CspHeaderGenerator::createHeaderObject() — Method in class CspHeaderGenerator

Create header object

CspHeaderGeneratorFactoryClass in namespace VuFind\Security

Factory for creating Content Security Policy http headers generator class

$ AbstractPluginFactory#classSuffixProperty in class AbstractPluginFactory

Optional suffix to append to class names

AbstractPluginFactory::canCreate() — Method in class AbstractPluginFactory

Can we create a service for the specified name?

CurrencyFormatterClass in namespace VuFind\Service

Currency formatter

CurrencyFormatter::convertToDisplayFormat() — Method in class CurrencyFormatter

Convert currency from float to display format

CurrencyFormatterFactoryClass in namespace VuFind\Service

CurrencyFormatter Factory

$ MarkdownFactory#configKeysProperty in class MarkdownFactory

Array of config keys for extensions classes

$ MarkdownFactory#configProperty in class MarkdownFactory

Markdown processor configuration

$ MarkdownFactory#containerProperty in class MarkdownFactory

Dependency injection container

MarkdownFactory::createConfig() — Method in class MarkdownFactory

Create full config for markdown converter

AbstractBase::close() — Method in class AbstractBase

Close function, this works like a destructor in classes and is executed when the session operation is done.

$ Memcache#connectionProperty in class Memcache

Memcache connection

Memcache::connect() — Method in class Memcache

Set up the connection to Memcache.

$ Redis#connectionProperty in class Redis

Redis connection

$ SecureDelegator#cipherProperty in class SecureDelegator

The block cipher for en/decrypting session data.

$ SecureDelegator#cookieManagerProperty in class SecureDelegator

VuFind cookie manager service.

AbstractFile::clear() — Method in class AbstractFile

Remove all entries

$ Generator#configProperty in class Generator

Sitemap configuration (sitemap.ini)

$ Generator#countPerPageProperty in class Generator

URL entries per sitemap

ContentPagesClass in namespace VuFind\Sitemap\Plugin

Content pages generator plugin

$ ContentPages#configProperty in class ContentPages

Main VuFind configuration (config.ini)

ContentPagesFactoryClass in namespace VuFind\Sitemap\Plugin

Content pages generator plugin factory

$ Index#countPerPageProperty in class Index

Page size for data retrieval

CursorMarkIdFetcherClass in namespace VuFind\Sitemap\Plugin\Index

Plugin to get IDs for a sitemap from a backend using cursor marks (if supported).

$ Writer#changeTrackerProperty in class Writer

Change tracker database table gateway

Writer::commit() — Method in class Writer

Commit the index.

CsrfInterfaceClass in namespace VuFind\Validator

Interface for Csrf validator

CopyToClipboardButtonClass in namespace VuFind\View\Helper\Bootstrap3

Class CopyClipboardButton

CaptchaClass in namespace VuFind\View\Helper\Root

Captcha view helper

$ Captcha#captchasProperty in class Captcha

Captcha services

$ Captcha#configProperty in class Captcha
Config
CaptchaFactoryClass in namespace VuFind\View\Helper\Root

Captcha helper factory.

CartClass in namespace VuFind\View\Helper\Root

Cart view helper

$ Cart#cartProperty in class Cart

VuFind Cart Model

CartFactoryClass in namespace VuFind\View\Helper\Root

Cart helper factory.

CitationClass in namespace VuFind\View\Helper\Root

Citation view helper

Citation::cleanNameDates() — Method in class Citation

Strip the dates off the end of a name.

Citation::capitalizeTitle() — Method in class Citation

Capitalize all words in a title, except for a few common exceptions.

CitationFactoryClass in namespace VuFind\View\Helper\Root

Citation helper factory.

ClassBasedTemplateRendererTraitClass in namespace VuFind\View\Helper\Root

Trait for view helpers that render a template based on a class name.

ComponentClass in namespace VuFind\View\Helper\Root

Component view helper

ConfigClass in namespace VuFind\View\Helper\Root

Config view helper

$ Config#configLoaderProperty in class Config

Configuration plugin manager

ConfigFactoryClass in namespace VuFind\View\Helper\Root

Config helper factory.

ContentClass in namespace VuFind\View\Helper\Root

Content View Helper to resolve translated pages.

$ Content#contextHelperProperty in class Content

Context View Helper instance to resolve translated pages.

ContentBlockClass in namespace VuFind\View\Helper\Root

ContentBlock view helper

ContentFactoryClass in namespace VuFind\View\Helper\Root

Content helper factory.

ContentLoaderClass in namespace VuFind\View\Helper\Root

Content loader view helper

ContentLoaderFactoryClass in namespace VuFind\View\Helper\Root

ContentLoader helper factory.

ContextClass in namespace VuFind\View\Helper\Root

Context manager (useful for using render() instead of partial() for better performance -- this allows us to set and roll back variables in the global scope instead of relying on the overhead of building a whole new scope).

CookieConsentClass in namespace VuFind\View\Helper\Root

CookieConsent view helper

$ CookieConsent#configProperty in class CookieConsent

Main configuration

$ CookieConsent#consentConfigProperty in class CookieConsent

Cookie consent configuration

$ CookieConsent#cookieManagerProperty in class CookieConsent

Cookie manager

$ CookieConsent#consentCookieNameProperty in class CookieConsent

Consent cookie name

$ CookieConsent#consentCookieExpirationProperty in class CookieConsent

Consent cookie expiration time

CookieConsentFactoryClass in namespace VuFind\View\Helper\Root

CookieConsent helper factory.

CspClass in namespace VuFind\View\Helper\Root

Content Security Policy view helper

CspFactoryClass in namespace VuFind\View\Helper\Root

CSP helper factory.

CspNonceClass in namespace VuFind\View\Helper\Root

CSP nonce view helper

$ CspNonce#cspNonceProperty in class CspNonce

CSP nonce

CspNonceFactoryClass in namespace VuFind\View\Helper\Root

CSP nonce helper factory.

CurrentPathClass in namespace VuFind\View\Helper\Root

Current path view helper

$ DateTime#converterProperty in class DateTime

Date converter

$ Doi#contextProperty in class Doi

Context helper

$ Doi#configProperty in class Doi

VuFind OpenURL configuration

Doi::checkContext() — Method in class Doi

Does the configuration indicate that we should display DOI links in the specified context?

$ GeoCoords#coordsProperty in class GeoCoords

Default coordinates

$ GoogleAnalytics#createOptionsProperty in class GoogleAnalytics

Options to pass to the ga() create command.

$ HelpText#contentHelperProperty in class HelpText

The content view helper

$ HistoryLabel#configProperty in class HistoryLabel

Label configuration

$ Holdings#configProperty in class Holdings
Configuration
$ Icon#configProperty in class Icon

Icon config from theme.config.php

$ Icon#cacheProperty in class Icon

Cache for icons

Icon::compileAttrs() — Method in class Icon

Reduce extra parameters to one attribute string.

Icon::cacheKey() — Method in class Icon

Create a unique key for icon names and extra attributes

$ Ils#connectionProperty in class Ils

ILS connection

MakeTag::compileTag() — Method in class MakeTag

Turn associative array into a string of attributes in an anchor

$ Markdown#converterProperty in class Markdown

Markdown converter

$ Matomo#customVarsProperty in class Matomo

Whether to use custom variables to track additional information

$ Matomo#customDimensionsProperty in class Matomo

Mappings from data fields to custom dimensions for tracking additional information

$ Matomo#contextProperty in class Matomo

Tracker initialization context ('', 'lightbox', 'accordion' or 'tabs')

$ Metadata#configProperty in class Metadata

Metadata configuration entries

$ OpenUrl#contextProperty in class OpenUrl

Context helper

$ OpenUrl#configProperty in class OpenUrl

VuFind OpenURL configuration

OpenUrl::checkContext() — Method in class OpenUrl

Does the OpenURL configuration indicate that we should display OpenURLs in the specified context?

OpenUrl::checkIfRulesApply() — Method in class OpenUrl

Check if the rulesets found apply to the current record. First match counts.

OpenUrl::checkExcludedRecordsRules() — Method in class OpenUrl

Check if "exclude" rules from the OpenUrlRules.json file apply to the current record

OpenUrl::checkSupportedRecordsRules() — Method in class OpenUrl

Check if "include" rules from the OpenUrlRules.json file apply to the current record

OpenUrl::checkMethodRules() — Method in class OpenUrl

Check if method rules match.

OpenUrl::checkRules() — Method in class OpenUrl

Checks if rules from the OpenUrlRules.json file apply to the current record

$ Overdrive#connectorProperty in class Overdrive

Overdrive connector.

$ Piwik#customVarsProperty in class Piwik

Whether to track use custom variables to track additional information

$ ProxyUrl#configProperty in class ProxyUrl

VuFind configuration

$ Record#contextHelperProperty in class Record

Context view helper

$ Record#coverRouterProperty in class Record

Cover router

$ Record#configProperty in class Record

VuFind configuration

$ Relais#configProperty in class Relais

Relais configuration (or null if none found)

$ Related#configManagerProperty in class Related

Config manager

$ SafeMoneyFormat#currencyFormatterProperty in class SafeMoneyFormat
CurrencyFormatter
$ SearchBox#configProperty in class SearchBox

Configuration for search box.

$ SearchBox#cachedConfigsProperty in class SearchBox

Cache for configurations

SearchBox::combinedHandlersActive() — Method in class SearchBox

Are combined handlers enabled?

$ SearchTabs#cachedHiddenFilterParamsProperty in class SearchTabs

Cached hidden filter url params

SearchTabs::createSelectedTab() — Method in class SearchTabs

Create information representing a selected tab.

SearchTabs::createBasicTab() — Method in class SearchTabs

Create information representing a basic search tab.

SearchTabs::createHomeTab() — Method in class SearchTabs

Create information representing a tab linking to "search home."

SearchTabs::createAdvancedTab() — Method in class SearchTabs

Create information representing an advanced search tab.

$ SyndeticsPlus#configProperty in class SyndeticsPlus

Syndetics configuration

D

$ SearchApiController#defaultItemFieldsProperty in class SearchApiController

Default item fields to return if a request does not define the fields

$ ClearCacheCommand#defaultNameProperty in class ClearCacheCommand

The name of the command (the part after "public/index.php")

$ ExpireCsrfTokensCommand#defaultNameProperty in class ExpireCsrfTokensCommand

The name of the command (the part after "public/index.php")

$ ExpireUsersCommand#defaultNameProperty in class ExpireUsersCommand

The name of the command (the part after "public/index.php")

$ UpdateResourcesFromSolrCommand#defaultNameProperty in class UpdateResourcesFromSolrCommand

The name of the command (the part after "public/index.php")

$ XCNCIP2Test#driverProperty in class XCNCIP2Test

ILS driver

DocumentTypesClass in namespace KnihovnyCz\ContentBlock

Object Definition for Document types content block

DocumentTypesFactoryClass in namespace KnihovnyCz\ContentBlock

Document types content block factory.

PageLocator::determineTemplateAndRenderer() — Method in class PageLocator

Try to find template information about desired page

LibraryCardsController::deleteCardAction() — Method in class LibraryCardsController

Creates a confirmation box to delete or not delete the current list

$ MyResearchController#dateConverterProperty in class MyResearchController

Date converter object

MyResearchController::deleteUserAction() — Method in class MyResearchController

Delete user account if it is confirmed

RecordController::dispatch() — Method in class RecordController

Dispatch a request

SearchController::dispatch() — Method in class SearchController

Dispatch a request

SearchController::disableLastInPagination() — Method in class SearchController

Disable link to page with the last results in pagination if the limit on numer of results is exceeded.

User::deleteLibraryCard() — Method in class User

Delete library card

UserList::delete() — Method in class UserList

Destroy the list.

$ KohaRest1905#dateConverterProperty in class KohaRest1905

Date converter object

$ KohaRest1905#defaultPickUpLocationProperty in class KohaRest1905

Default pickup location code

KohaRest1905::determineDueStatus() — Method in class KohaRest1905

Due status determination logic

KohaRest1905::determineStatus() — Method in class KohaRest1905

Determine item status string

KohaRest1905::determineAvailability() — Method in class KohaRest1905

Determine item availability

KohaRest1905::determineDuedate() — Method in class KohaRest1905

Determine due date from availability data

$ MultiBackend#dateConverterProperty in class MultiBackend

Date converter object

Holds::driverHoldings() — Method in class Holds

Protected method for driver defined holdings

$ SolrIdResolver#defaultSolrQueryFieldProperty in class SolrIdResolver

Solr field to search in

$ SolrIdResolver#defaultItemIdentifierProperty in class SolrIdResolver

Item identifier field in item data array

DedupedRecordsClass in namespace KnihovnyCz\RecordTab

Class DedupedRecords

$ Params#defaultFacetLabelSectionsProperty in class Params

Config sections to search for facet labels if no override configuration is set.

DeduplicationHelperClass in namespace KnihovnyCz\Search\Solr

Solr deduplication helper

DeduplicationListenerClass in namespace KnihovnyCz\Search\Solr

Solr merged record handling listener.

DeduplicationListener::determineRecordPriority() — Method in class DeduplicationListener

Function that determines the priority for sources

$ CitaceProService#defaultCitationStyleProperty in class CitaceProService
$ WayfFilterGenerator#defaultFeedProperty in class WayfFilterGenerator
NullSessionManager::destroy() — Method in class NullSessionManager

Destroy/end a session

DatabaseCsrfClass in namespace KnihovnyCz\Validator

Extension of Laminas\Validator\Csrf with token counting/clearing functions added.

DatabaseCsrfFactoryClass in namespace KnihovnyCz\Validator

Search history factory.

$ TextFormatter#driverProperty in class TextFormatter

Record driver

AbstractAdmin::disabledAction() — Method in class AbstractAdmin

Display disabled message.

AdminController::disabledAction() — Method in class AdminController

Display disabled message.

FeedbackController::deleteAction() — Method in class FeedbackController

Delete action

MaintenanceController::deleteexpiredsearchesAction() — Method in class MaintenanceController

Delete expired searches.

MaintenanceController::deleteexpiredsessionsAction() — Method in class MaintenanceController

Delete expired sessions.

TagsController::deleteAction() — Method in class TagsController

Delete Tags

TagsController::deleteResourceTagsByFilter() — Method in class TagsController

Delete tags based on filter settings.

$ AdminApiController#defaultIgnoredCachesProperty in class AdminApiController

Caches that are not cleared by the clearCache command by default

ApiTrait::determineOutputMode() — Method in class ApiTrait

Determine the correct output mode based on content negotiation or the view parameter

$ SearchApiController#defaultRecordFieldsProperty in class SearchApiController

Default record fields to return if a request does not define the fields

$ ThemeCommand#defaultNameProperty in class ThemeCommand

The name of the command (the part after "public/index.php")

DynamicRouteCommandClass in namespace VuFindConsole\Command\Generate

Console command: Generate dynamic route.

$ DynamicRouteCommand#defaultNameProperty in class DynamicRouteCommand

The name of the command (the part after "public/index.php")

$ ExtendClassCommand#defaultNameProperty in class ExtendClassCommand

The name of the command (the part after "public/index.php")

$ ExtendServiceCommand#defaultNameProperty in class ExtendServiceCommand

The name of the command (the part after "public/index.php")

$ NonTabRecordActionCommand#defaultNameProperty in class NonTabRecordActionCommand

The name of the command (the part after "public/index.php")

$ PluginCommand#defaultNameProperty in class PluginCommand

The name of the command (the part after "public/index.php")

$ RecordRouteCommand#defaultNameProperty in class RecordRouteCommand

The name of the command (the part after "public/index.php")

$ StaticRouteCommand#defaultNameProperty in class StaticRouteCommand

The name of the command (the part after "public/index.php")

$ ThemeCommand#defaultNameProperty in class ThemeCommand

The name of the command (the part after "public/index.php")

$ ThemeMixinCommand#defaultNameProperty in class ThemeMixinCommand

The name of the command (the part after "public/index.php")

$ HarvestOaiCommand#defaultNameProperty in class HarvestOaiCommand

The name of the command

$ MergeMarcCommand#defaultNameProperty in class MergeMarcCommand

The name of the command (the part after "public/index.php")

$ ImportCsvCommand#defaultNameProperty in class ImportCsvCommand

The name of the command

$ ImportXslCommand#defaultNameProperty in class ImportXslCommand

The name of the command

$ WebCrawlCommand#defaultNameProperty in class WebCrawlCommand

The name of the command

WebCrawlCommand::downloadFile() — Method in class WebCrawlCommand

Download a URL to a temporary file.

$ InstallCommand#defaultNameProperty in class InstallCommand

The name of the command (the part after "public/index.php")

InstallCommand::displaySuccessMessage() — Method in class InstallCommand

Display the final message after successful installation.

$ AddUsingTemplateCommand#defaultNameProperty in class AddUsingTemplateCommand

The name of the command (the part after "public/index.php")

$ CopyStringCommand#defaultNameProperty in class CopyStringCommand

The name of the command (the part after "public/index.php")

DeleteCommandClass in namespace VuFindConsole\Command\Language

Language command: add string using template.

$ DeleteCommand#defaultNameProperty in class DeleteCommand

The name of the command (the part after "public/index.php")

$ NormalizeCommand#defaultNameProperty in class NormalizeCommand

The name of the command (the part after "public/index.php")

$ NotifyCommand#defaultNameProperty in class NotifyCommand

The name of the command (the part after "public/index.php")

$ AbstractExpireCommand#defaultAgeProperty in class AbstractExpireCommand

Default age of rows (in days) to delete. $minAge is used if $defaultAge is null.

$ CleanUpRecordCacheCommand#defaultNameProperty in class CleanUpRecordCacheCommand

The name of the command (the part after "public/index.php")

$ CommitCommand#defaultNameProperty in class CommitCommand

The name of the command (the part after "public/index.php")

$ CreateHierarchyTreesCommand#defaultNameProperty in class CreateHierarchyTreesCommand

The name of the command (the part after "public/index.php")

DedupeCommandClass in namespace VuFindConsole\Command\Util

Console command: deduplicate lines in a sorted file.

$ DedupeCommand#defaultNameProperty in class DedupeCommand

The name of the command (the part after "public/index.php")

DeletesCommandClass in namespace VuFindConsole\Command\Util

Console command: delete from Solr

$ DeletesCommand#defaultNameProperty in class DeletesCommand

The name of the command (the part after "public/index.php")

$ ExpireAccessTokensCommand#defaultNameProperty in class ExpireAccessTokensCommand

The name of the command (the part after "public/index.php")

$ ExpireAuthHashesCommand#defaultNameProperty in class ExpireAuthHashesCommand

The name of the command (the part after "public/index.php")

$ ExpireExternalSessionsCommand#defaultNameProperty in class ExpireExternalSessionsCommand

The name of the command (the part after "public/index.php")

$ ExpireSearchesCommand#defaultNameProperty in class ExpireSearchesCommand

The name of the command (the part after "public/index.php")

$ ExpireSessionsCommand#defaultAgeProperty in class ExpireSessionsCommand

Default age of rows to delete. $minAge is used $defaultAge is null.

$ ExpireSessionsCommand#defaultNameProperty in class ExpireSessionsCommand

The name of the command (the part after "public/index.php")

$ IndexReservesCommand#defaultNameProperty in class IndexReservesCommand

The name of the command (the part after "public/index.php")

$ IndexReservesCommand#defaultDelimiterProperty in class IndexReservesCommand

Default delimiter for reading files

$ IndexReservesCommand#defaultTemplateProperty in class IndexReservesCommand

Default template for reading files

$ LintMarcCommand#defaultNameProperty in class LintMarcCommand

The name of the command (the part after "public/index.php")

$ OptimizeCommand#defaultNameProperty in class OptimizeCommand

The name of the command (the part after "public/index.php")

$ ScssBuilderCommand#defaultNameProperty in class ScssBuilderCommand

The name of the command (the part after "public/index.php")

$ SitemapCommand#defaultNameProperty in class SitemapCommand

The name of the command (the part after "public/index.php")

$ SuppressedCommand#defaultNameProperty in class SuppressedCommand

The name of the command (the part after "public/index.php")

$ SwitchDbHashCommand#defaultNameProperty in class SwitchDbHashCommand

The name of the command (the part after "public/index.php")

DevtoolsControllerClass in namespace VuFindDevTools\Controller

Development Tools Controller

DevtoolsController::deminifyAction() — Method in class DevtoolsController

Deminify action

$ LookupDoiCommand#doiProperty in class LookupDoiCommand

DOI to look up.

$ Backend#defaultProfileProperty in class Backend

Default profile for EBSCO EDS API account (taken from initial config and never changed)

Backend::debugPrint() — Method in class Backend

Print a message if debug is enabled.

$ Base#debugProperty in class Base

A boolean value determining whether to print debug information

Base::debugPrint() — Method in class Base

Print a message if debug is enabled.

$ AutocompleteCommand#domainProperty in class AutocompleteCommand

Autocomplete type.

Connector::debugPrint() — Method in class Connector

Print a message if debug is enabled.

$ QueryBuilder#defaultQueryProperty in class QueryBuilder

Default query (used when query string is empty). This should retrieve all records in the index, facilitating high-level facet-based browsing.

$ Connector#dbsProperty in class Connector

Array of 3-character EBSCO database abbreviations to include in search

DeepPagingExceptionClass in namespace VuFindSearch\Backend\Exception

Exception for paging too deep into search results.

$ Backend#defaultSearchProperty in class Backend

Default search (performed if another search has 0 results; null to disable.

Backend::deserialize() — Method in class Backend

Deserialize JSON response.

$ WriteDocumentCommand#docProperty in class WriteDocumentCommand

Document to write.

DeleteDocumentClass in namespace VuFindSearch\Backend\Solr\Document

SOLR delete document class.

DocumentInterfaceClass in namespace VuFindSearch\Backend\Solr\Document

Interface for Solr document classes

$ QueryBuilder#defaultDismaxHandlerProperty in class QueryBuilder

Default dismax handler (if no DismaxHandler set in specs).

SearchHandler::dismaxSubquery() — Method in class SearchHandler

Return a Dismax subquery for specified search string.

SearchHandler::dismaxMunge() — Method in class SearchHandler

Apply custom search string munging to a Dismax query.

DoiLookupTestClass in namespace VuFindTest\AjaxHandler

DoiLookup test class.

DatabaseTestClass in namespace VuFindTest\Auth

Database authentication test class.

DatabaseUnitTestClass in namespace VuFindTest\Auth

Database authentication test class.

QueryBuilderTest::decodeResponse() — Method in class QueryBuilderTest

Given a response, decode the JSON query objects for easier reading.

DeleteDocumentTestClass in namespace VuFindTest\Backend\Solr\Document

Unit tests for SOLR delete document class.

DynamicRouteCommandTestClass in namespace VuFindTest\Command\Generate

Generate/DynamicRoute command test.

DeleteCommandTestClass in namespace VuFindTest\Command\Language

Language/Delete command test.

DedupeCommandTestClass in namespace VuFindTest\Command\Util

DedupeCommand test.

DeletesCommandTestClass in namespace VuFindTest\Command\Util

DeletesCommand test.

SwitchDbHashCommandTest::decode() — Method in class SwitchDbHashCommandTest

Decode a hash to confirm that it was encoded correctly.

$ MockContainerTrait#disabledProperty in class MockContainerTrait

Disabled services.

MockContainerTrait::disable() — Method in class MockContainerTrait

Disable a service

DeprecatedTestClass in namespace VuFindTest\Content\Covers

Unit tests for Deprecated cover loader.

DevtoolsControllerTestClass in namespace VuFindTest\Controller

Unit tests for DevTools controller.

MockLoader::debug() — Method in class MockLoader

Log a debug message.

CssPreCompilerTest::delTree() — Method in class CssPreCompilerTest

Delete a directory tree; adapted from http://php.net/manual/en/function.rmdir.php

DemoDriverTestTraitClass in namespace VuFindTest\Feature

Trait with utility methods for configuring the demo driver in a test

DAIATestClass in namespace VuFindTest\ILS\Driver

ILS driver test

DemoMockClass in namespace VuFindTest\ILS\Driver
DemoTestClass in namespace VuFindTest\ILS\Driver

ILS driver test

$ DemoTest#driverProperty in class DemoTest

Driver object

DummyILSClass in namespace VuFindTest\ILS\Driver

A dummy ILS driver used for testing a driver with unsupported features

$ FolioTest#defaultDriverConfigProperty in class FolioTest

Default test configuration

$ FolioTest#driverProperty in class FolioTest

Driver under test

$ GeniePlusTest#defaultPatronProperty in class GeniePlusTest

Default expected patron login response

$ NoILSTest#driverProperty in class NoILSTest

Driver object

$ SampleTest#driverProperty in class SampleTest

Driver object.

$ SymphonyTest#driverProperty in class SymphonyTest

Driver object

$ OAuth2TokenTraitTest#driverProperty in class OAuth2TokenTraitTest

Tested service

DublinCoreTestClass in namespace VuFindTest\MetadataVocabulary

DublinCore Test Class

VisualizationTest::doVisualizationCheck() — Method in class VisualizationTest

Run the basic visualization test procedure; this allows us to do the same checks in multiple configuration contexts.

DOITestClass in namespace VuFindTest\Recommend

DOI recommendation module Test Class

DefaultRecordTestClass in namespace VuFindTest\RecordDriver

DefaultRecord Record Driver Test Class

DescriptionTestClass in namespace VuFindTest\RecordTab

Description Test Class

$ TabManagerTest#defaultConfigProperty in class TabManagerTest

Default configuration for mock plugin manager

DynamicRoleProviderTestClass in namespace VuFindTest\Role

Dynamic Role Provider Test Class

DefaultParametersListenerTestClass in namespace VuFindTest\Search\Solr

Unit tests for DefaultParametersListener.

$ Results#driverCacheProperty in class Results

Cache for fake drivers

DatabaseTestClass in namespace VuFindTest\Session

Database Session Handler Test Class

$ ILSDriverTestCase#driverProperty in class ILSDriverTestCase

ILS driver

DatabaseTestClass in namespace VuFindTest\UrlShortener

"Database" URL shortener test.

AbstractThemeUtility::deleteDir() — Method in class AbstractThemeUtility

Recursively delete a directory and its contents.

$ Mobile#detectorProperty in class Mobile

Mobile detection object

Mobile::detect() — Method in class Mobile

Function to detect if a mobile device is being used.

ResourceContainer::dynamicallyParsed() — Method in class ResourceContainer

Check if a CSS file is being dynamically compiled in LESS

AbstractBase::disableSessionWrites() — Method in class AbstractBase

Prevent session writes -- this is designed to be called prior to time- consuming AJAX operations to help reduce the odds of a timing-related bug that causes the wrong version of session data to be written to disk (see VUFIND-716 for more details).

DeleteRecordCommentClass in namespace VuFind\AjaxHandler

AJAX handler to delete a comment on a record.

DeleteRecordCommentFactoryClass in namespace VuFind\AjaxHandler

Factory for DeleteRecordComment AJAX handler.

DoiLookupClass in namespace VuFind\AjaxHandler

AJAX handler to look up DOI data.

DoiLookupFactoryClass in namespace VuFind\AjaxHandler

Factory for DoiLookup AJAX handler.

DatabaseClass in namespace VuFind\Auth

Database authentication class

Manager::dropdownEnabled() — Method in class Manager

Is login currently allowed?

$ Eds#domainProperty in class Eds

Eds domain

$ Solr#displayFieldProperty in class Solr

Solr field to use for display

$ Solr#defaultDisplayFieldProperty in class Solr

Default Solr display field if none is configured

$ Manager#defaultsProperty in class Manager

Default configuration settings.

$ Manager#directoryCreationErrorProperty in class Manager

Was there a problem building cache directories?

DemoClass in namespace VuFind\Captcha

Demo CAPTCHA (expect hard-coded value; used for test suite only).

$ ListItems#displayPublicListsProperty in class ListItems

Should we pull in public list results in addition to the inclusion list in $ids?

$ PathResolverFactory#defaultBaseConfigSubdirProperty in class PathResolverFactory

Default base config file subdirectory under the base directory

$ PathResolverFactory#defaultLocalConfigSubdirProperty in class PathResolverFactory

Default config file subdirectory under a local override directory

$ Oracle#dbHandleProperty in class Oracle

Database Handle

$ AbstractCover#directUrlsProperty in class AbstractCover

Use direct urls as image urls. When set to true, direct urls to content cover provider will be used in interface instead internal Cover/Show urls.

DemoClass in namespace VuFind\Content\AuthorNotes

Demo (fake data) author notes content loader.

DeprecatedClass in namespace VuFind\Content\Covers

Deprecated cover content loader (for backward-compatibility with deprecated settings).

DeprecatedClass in namespace VuFind\Content

Deprecated content loader (used for backward compatibility with deprecated settings).

DemoClass in namespace VuFind\Content\Excerpts

Demo (fake data) excerpts content loader.

$ PageLocator#defaultLanguageProperty in class PageLocator

Default language

PageLocator::determineTemplateAndRenderer() — Method in class PageLocator

Try to find template information about desired page

DemoClass in namespace VuFind\Content\Reviews

Demo (fake data) reviews content loader.

DemoClass in namespace VuFind\Content\Summaries

Demo (fake data) summaries content loader.

DemoClass in namespace VuFind\Content\TOC

Demo (fake data) TOC content loader.

AbstractBase::disableSessionWrites() — Method in class AbstractBase

Prevent session writes -- this is designed to be called prior to time- consuming AJAX operations to help reduce the odds of a timing-related bug that causes the wrong version of session data to be written to disk (see VUFIND-716 for more details).

AbstractBase::dbUpgrade() — Method in class AbstractBase

DbUpgrade plugin

$ AbstractRecord#defaultTabProperty in class AbstractRecord

Default tab to display (configured at record driver level)

$ AbstractRecord#driverProperty in class AbstractRecord

Record driver

AbstractRecord::deletecommentAction() — Method in class AbstractRecord

Delete a comment

AbstractRecord::deletetagAction() — Method in class AbstractRecord

Delete a tag

$ AlphabrowseController#defaultTypesProperty in class AlphabrowseController

Default browse types

$ AlphabrowseController#defaultExtrasProperty in class AlphabrowseController

Default extras

$ BrowseController#disabledFacetsProperty in class BrowseController

Browse options disabled in configuration

BrowseController::deweyAction() — Method in class BrowseController

Browse Dewey

CartController::doexportAction() — Method in class CartController

Actually perform the export operation.

CoverController::displayImage() — Method in class CoverController

Support method -- update the view to display the image currently found in the \VuFind\Cover\Loader.

InstallController::disabledAction() — Method in class InstallController

Display disabled message.

InstallController::doneAction() — Method in class InstallController

Disable auto-configuration.

LibraryCardsController::deleteCardAction() — Method in class LibraryCardsController

Creates a confirmation box to delete or not delete the current list

MyResearchController::deleteAction() — Method in class MyResearchController

Delete group of records from favorites.

MyResearchController::deletelistAction() — Method in class MyResearchController

Creates a confirmation box to delete or not delete the current list

MyResearchController::deleteAccountAction() — Method in class MyResearchController

Account deletion

$ AbstractRequestBase#dateConverterProperty in class AbstractRequestBase

Date converter

$ Captcha#domainsProperty in class Captcha

String array of forms where Captcha is active

DbUpgradeClass in namespace VuFind\Controller\Plugin

Action helper to perform database upgrades

$ DbUpgrade#dbCommandsProperty in class DbUpgrade

Database commands to generate table

DbUpgrade::defaultMatches() — Method in class DbUpgrade

Given a current row default, return true if the current default matches the one found in the SQL provided as the $sql parameter. Return false if there is a mismatch that will require table structure updates.

Favorites::delete() — Method in class Favorites

Delete a group of favorites.

$ ResultScroller#dataProperty in class ResultScroller

Session data used by scroller

QRCodeController::displayQRCode() — Method in class QRCodeController

Support method -- update the view to display the qrcode currently found in the \VuFind\QRCode\Loader.

UpgradeController::disabledAction() — Method in class UpgradeController

Display disabled message.

$ CookieManager#domainProperty in class CookieManager

Cookie domain

$ Generator#defaultSettingsProperty in class Generator

Default settings (values used by setOptions() if not overridden).

Generator::destroyImage() — Method in class Generator

Clear the resources associated with the image in the object.

AbstractTextLayer::drawText() — Method in class AbstractTextLayer

Simulate outlined text

DefaultTextClass in namespace VuFind\Cover\Layer

Default cover text layer

DefaultText::drawTitle() — Method in class DefaultText

Render title in wrapped, black text with white border

DefaultText::drawAuthor() — Method in class DefaultText

Render author at bottom in wrapped, white text with black border

Loader::determineLocalFile() — Method in class Loader

Support method for fetchFromAPI() -- set the localFile property.

$ Router#dynamicUrlProperty in class Router

Base URL for dynamic cover images.

Base62::decode() — Method in class Base62

Common base62 decoding function.

Resource::deleteTags() — Method in class Resource

Remove tags from the current resource.

Resource::deleteTag() — Method in class Resource

Remove a tag from the current resource.

User::deleteLibraryCard() — Method in class User

Delete library card

User::delete() — Method in class User

Destroy the user.

$ UserList#descriptionProperty in class UserList
UserList::delete() — Method in class UserList

Destroy the list.

$ ChangeTracker#dateFormatProperty in class ChangeTracker

Date/time format for database

Comments::deleteIfOwnedByUser() — Method in class Comments

Delete a comment if the owner is logged in. Returns true on success.

Comments::deleteByUser() — Method in class Comments

Deletes all comments by a user.

DbTableAwareInterfaceClass in namespace VuFind\Db\Table

Marker interface for classes that depend on the \VuFind\Db\Table\PluginManager

DbTableAwareTraitClass in namespace VuFind\Db\Table

Default implementation of DbTableAwareInterface.

ExpirationTrait::deleteExpired() — Method in class ExpirationTrait

Delete expired records. Allows setting of 'from' and 'to' ID's so that rows can be deleted in small batches.

ExternalSession::destroySession() — Method in class ExternalSession

Destroy data for the given session ID.

Feedback::deleteByIdArray() — Method in class Feedback

Delete feedback by ids

Ratings::deleteIfOwnedByUser() — Method in class Ratings

Delete a rating if the owner is logged in. Returns true on success.

Ratings::deleteByUser() — Method in class Ratings

Deletes all ratings by a user.

$ Resource#dateConverterProperty in class Resource

Date converter

ResourceTags::destroyResourceLinks() — Method in class ResourceTags

Unlink rows for the specified resource.

ResourceTags::destroyListLinks() — Method in class ResourceTags

Unlink rows for the specified user list.

ResourceTags::deleteByIdArray() — Method in class ResourceTags

Delete a group of tags.

ResourceTags::deduplicate() — Method in class ResourceTags

Deduplicate rows (sometimes necessary after merging foreign key IDs).

Search::destroySession() — Method in class Search

Destroy unsaved searches belonging to the specified session/user.

Session::destroySession() — Method in class Session

Destroy data for the given session ID.

Tags::deleteByIdArray() — Method in class Tags

Delete a group of tags.

UserResource::destroyLinks() — Method in class UserResource

Unlink rows for the specified resource. This will also automatically remove any tags associated with the relationship.

UserResource::deduplicate() — Method in class UserResource

Deduplicate rows (sometimes necessary after merging foreign key IDs).

OverdriveConnector::doOverdriveCheckout() — Method in class OverdriveConnector

Overdrive Checkout Processes a request to checkout a title from Overdrive

$ BrowZine#doiServicesProperty in class BrowZine

Configured DOI services

DemoClass in namespace VuFind\DoiLinker

Demo (fake data) DOI linker

DoiLinkerInterfaceClass in namespace VuFind\DoiLinker

DOI linker interface

$ Entry#dcFormatsProperty in class Entry
Formats
$ Entry#dcDateProperty in class Entry
Date
$ Form#defaultFormConfigProperty in class Form

Default form configuration (from config.ini > Feedback)

DatabaseClass in namespace VuFind\Form\Handler

Class Database

DatabaseFactoryClass in namespace VuFind\Form\Handler

Class DatabaseFactory

$ AbstractBase#dataManagerProperty in class AbstractBase

Tree data source plugin manager

$ ConfigurationBased#defaultTreeRendererProperty in class ConfigurationBased

Default tree renderer

$ AbstractBase#dataSourceProperty in class AbstractBase

Source of hierarchy data

CachingDownloader::download() — Method in class CachingDownloader

Download a resource using the cache in the background.

CachingDownloader::downloadJson() — Method in class CachingDownloader

Download a resource using the cache in the background, including decoding for JSON.

$ CachingDownloaderAwareTrait#downloaderCacheIdProperty in class CachingDownloaderAwareTrait

Cache ID. This can be overridden by child classes if they want to use a separate cache.

LocaleDetectorParamStrategy::detect() — Method in class LocaleDetectorParamStrategy

Attempt to detect the locale from a POST parameter.

$ LocaleSettings#defaultLocaleProperty in class LocaleSettings

Default locale (code)

$ TranslatableString#displayStringProperty in class TranslatableString

Default display string

$ Connection#driverInitializedProperty in class Connection

Has the driver been initialized yet?

$ Connection#driverProperty in class Connection

The object of the appropriate driver.

$ Connection#driverManagerProperty in class Connection

Driver plugin manager

AbstractAPI::debugRequest() — Method in class AbstractAPI

Function that obscures and logs debug data

$ Aleph#dateConverterProperty in class Aleph

Date converter object

$ Aleph#dlfbaseurlProperty in class Aleph

The base URL, where the REST DLF API is running

$ Aleph#dlfportProperty in class Aleph

DLF REST API port

$ Aleph#debug_enabledProperty in class Aleph

Is debug mode enabled?

$ Aleph#defaultPatronIdProperty in class Aleph

Patron id used when no specific patron defined

Aleph::doXRequest() — Method in class Aleph

Perform an XServer request.

Aleph::doRestDLFRequest() — Method in class Aleph

Perform a RESTful DLF request.

Aleph::doHTTPRequest() — Method in class Aleph

Perform an HTTP request.

$ Alma#dateConverterProperty in class Alma

Date converter

$ Amicus#dbProperty in class Amicus

Database connection

Amicus::determineAvailability() — Method in class Amicus

Support method to take an array of status strings and determine whether or not this indicates an available item. Returns an array with two keys: 'available', the boolean availability status, and 'otherStatuses', every status code found other than "Not Charged" - for use with _pickStatus().

DAIAClass in namespace VuFind\ILS\Driver

ILS Driver for VuFind to query availability information via DAIA.

$ DAIA#daiaTimeoutProperty in class DAIA

Timeout in seconds to be used for DAIA http requests

$ DAIA#daiaCacheEnabledProperty in class DAIA

Flag to switch on/off caching for DAIA items

$ DAIA#daiaIdPrefixProperty in class DAIA

DAIA query identifier prefix

$ DAIA#daiaResponseFormatProperty in class DAIA

DAIA response format

$ DAIA#dateConverterProperty in class DAIA

Date converter object

DAIA::doHTTPRequest() — Method in class DAIA

Perform an HTTP request.

DemoClass in namespace VuFind\ILS\Driver

Advanced Dummy ILS Driver -- Returns sample values based on Solr index.

$ Demo#dateConverterProperty in class Demo

Date converter object

$ Demo#departmentsProperty in class Demo

Departments for use in course reserves.

$ Demo#defaultPickUpLocationProperty in class Demo

Default pickup location

DemoFactoryClass in namespace VuFind\ILS\Driver

Factory for Demo ILS driver.

DriverInterfaceClass in namespace VuFind\ILS\Driver

Catalog Specific Driver Class

DriverWithDateConverterFactoryClass in namespace VuFind\ILS\Driver

Generic factory suitable for most ILS drivers.

$ Evergreen#dbProperty in class Evergreen

Database connection

$ Evergreen#dbNameProperty in class Evergreen

Database name

$ Evergreen#dateConverterProperty in class Evergreen

Date converter object

$ Folio#dateConverterProperty in class Folio

Date converter

$ Folio#defaultAvailabilityStatusesProperty in class Folio

Default availability messages, in case they are not defined in Folio.ini

$ Folio#defaultInTransitStatusesProperty in class Folio

Default in_transit messages, in case they are not defined in Folio.ini

Folio::debugRequest() — Method in class Folio

Function that obscures and logs debug data

$ Horizon#dateFormatProperty in class Horizon

Date converter object

$ Horizon#dbProperty in class Horizon

Database connection

HorizonXMLAPI::determineRenewability() — Method in class HorizonXMLAPI

Determine Renewability

$ Koha#dbProperty in class Koha

Database connection

$ Koha#dateConverterProperty in class Koha

Date converter object

Koha::displayDate() — Method in class Koha

Convert a database date to a displayable date.

Koha::displayDateTime() — Method in class Koha

Convert a database datetime to a displayable date and time.

$ KohaILSDI#defaultLocationProperty in class KohaILSDI

Default location code

$ KohaILSDI#dbProperty in class KohaILSDI

Database connection

$ KohaILSDI#dateConverterProperty in class KohaILSDI

Date converter object

KohaILSDI::displayDate() — Method in class KohaILSDI

Convert a database date to a displayable date.

KohaILSDI::displayDateTime() — Method in class KohaILSDI

Convert a database datetime to a displayable date and time.

$ KohaRest#dateConverterProperty in class KohaRest

Date converter object

$ KohaRest#defaultPickUpLocationProperty in class KohaRest

Default pickup location

$ MultiBackend#driversProperty in class MultiBackend

The array of configured driver names.

$ MultiBackend#defaultDriverProperty in class MultiBackend

The default driver to use

$ MultiBackend#driversConfigPathProperty in class MultiBackend

The path to the driver configurations relative to the config path

$ MultiBackend#driverCacheProperty in class MultiBackend

The array of cached drivers

$ MultiBackend#driverManagerProperty in class MultiBackend

ILS driver manager

MultiBackend::driverSupportsMethod() — Method in class MultiBackend

Check whether the given driver supports the given method

MultiBackend::driverSupportsSource() — Method in class MultiBackend

Check if the given ILS driver supports the source of a record

$ NewGenLib#dbProperty in class NewGenLib

Database connection

$ Polaris#defaultPickUpLocationProperty in class Polaris

Default pick up location

$ Sierra#dbProperty in class Sierra

Database connection

$ SierraRest#dateConverterProperty in class SierraRest

Date converter

$ SierraRest#defaultPickUpLocationProperty in class SierraRest

Default pickup location

$ Unicorn#dateConverterProperty in class Unicorn

Date converter object

Unicorn::decodeMarcHoldingRecord() — Method in class Unicorn

Decode a MARC holding record.

$ Virtua#dbProperty in class Virtua

Oracle connection

$ Voyager#dbNameProperty in class Voyager

Name of database

$ Voyager#dateFormatProperty in class Voyager

Date formatting object

$ Voyager#displayDueTimeIntervalsProperty in class Voyager

Loan interval types for which to display the due time (empty = all)

Voyager::debugSQL() — Method in class Voyager

Log an SQL statement debug message.

Voyager::determineAvailability() — Method in class Voyager

Protected support method to take an array of status strings and determine whether or not this indicates an available item. Returns an array with two keys: 'available', the boolean availability status, and 'otherStatuses', every status code found other than "Not Charged" - for use with pickStatus().

$ VoyagerRestful#defaultPickUpLocationProperty in class VoyagerRestful

Default pickup location

$ VoyagerRestful#defaultRequestGroupProperty in class VoyagerRestful

Default request group

VoyagerRestful::determineHoldType() — Method in class VoyagerRestful

Determine Hold Type

$ XCNCIP2#dateConverterProperty in class XCNCIP2

Date converter object

$ XCNCIP2#disableRenewalsProperty in class XCNCIP2

Are renewals disabled for this driver instance? Defaults to false

XCNCIP2::displayDate() — Method in class XCNCIP2

Convert a date to display format

XCNCIP2::displayTime() — Method in class XCNCIP2

Convert a time to display format

XCNCIP2::determineToAgencyId() — Method in class XCNCIP2

Determine ToAgencyId

Holds::driverHoldings() — Method in class Holds

Protected method for driver defined holdings

TitleHolds::driverHold() — Method in class TitleHolds

Protected method for driver defined title holds

$ ImageLoader#defaultFailImageProperty in class ImageLoader

Default image to load from theme if user-configured option fails.

$ Logger#debugNeededProperty in class Logger

Is debug logging enabled?

Logger::debugNeeded() — Method in class Logger

Is one of the log writers listening for debug messages? (This is useful to know, since some code can save time that would be otherwise wasted generating debug messages if we know that no one is listening).

LoggerAwareTrait::debug() — Method in class LoggerAwareTrait

Log a debug message.

DbClass in namespace VuFind\Log\Writer

This class extends the Laminas Logging towards DB

Db::doWrite() — Method in class Db

Write a message to the log.

Mail::doWrite() — Method in class Mail

Write a message to the log.

Post::doWrite() — Method in class Post

Write a message to the log.

Stream::doWrite() — Method in class Stream

Write a message to the log.

DublinCoreClass in namespace VuFind\MetadataVocabulary

Metadata vocabulary implementation for Dublin Core

DefaultSpellingNormalizerClass in namespace VuFind\Normalizer

Default text normalizer for spellcheck text replacement.

$ Server#defaultQueryProperty in class Server
$ Server#deleteLifetimeProperty in class Server

Limit on display of deleted records (in days); older deleted records will not be returned by the server. Set to null for no limit.

$ ScopeEntity#descriptionProperty in class ScopeEntity

Scope description

$ Loader#defaultParamsProperty in class Loader

The default params used to generate the QRCode

DOIClass in namespace VuFind\Recommend

DOI Recommendations Module

DPLATermsClass in namespace VuFind\Recommend

DPLATerms Recommendations Module

DPLATermsFactoryClass in namespace VuFind\Recommend

DPLATerms recommendation module factory.

DeprecatedClass in namespace VuFind\Recommend

Deprecated Recommendations Module - used to replace legacy modules that no longer function due to, for example, external APIs that have been shut down.

$ MapSelection#defaultCoordinatesProperty in class MapSelection

Default coordinates. Order is WENS

$ PubDateVisAjax#dateFacetsProperty in class PubDateVisAjax

Facet fields to use

$ RandomRecommend#displayModeProperty in class RandomRecommend

Display Mode

$ SideFacets#dateFacetsProperty in class SideFacets

Year-only date facet configuration

AbstractBase::deleteTags() — Method in class AbstractBase

Remove tags from the record.

DefaultRecordClass in namespace VuFind\RecordDriver

Default model for records

Missing::determineMissingTitle() — Method in class Missing

Format the missing title.

$ PluginManager#delegatorsProperty in class PluginManager

Default delegator factories.

$ PublicationDetails#dateProperty in class PublicationDetails

Date of publication

$ Summon#dateConverterProperty in class Summon

Date converter

$ AbstractBase#driverProperty in class AbstractBase

Record driver associated with the tab

DescriptionClass in namespace VuFind\RecordTab

Description tab

$ Map#displayCoordsProperty in class Map

Should we display coordinates as part of labels?

$ Bookplate#displayTitlesProperty in class Bookplate

Display bookplate titles?

Bookplate::displayBookplateTitles() — Method in class Bookplate

Display titles under bookplates.

$ Channels#driverProperty in class Channels

Record driver

DeprecatedClass in namespace VuFind\Related

Deprecated Related Records Module - used to replace legacy modules that no longer function due to, for example, external APIs that have been shut down.

$ CsvReader#delimiterProperty in class CsvReader

CSV delimiter

$ CsvReader#departmentsProperty in class CsvReader

Department data loaded from files

$ Connection#driverProperty in class Connection

The object of the appropriate driver.

Connection::disableCache() — Method in class Connection

Disable caching.

DemoClass in namespace VuFind\Resolver\Driver

Demo Link Resolver Driver

DriverInterfaceClass in namespace VuFind\Resolver\Driver

Resolver Specific Driver Class

DriverWithHttpClientFactoryClass in namespace VuFind\Resolver\Driver

Generic factory suitable for most resolver drivers.

Jop::downgradeOpenUrl() — Method in class Jop

Downgrade an OpenURL from v1.0 to v0.1 for compatibility with JOP.

DynamicRoleProviderClass in namespace VuFind\Role

VuFind dynamic role provider.

DynamicRoleProviderFactoryClass in namespace VuFind\Role

VuFind dynamic role provider factory.

$ PermissionDeniedManager#defaultDeniedControllerBehaviorProperty in class PermissionDeniedManager

Default behavior for denied permissions at the controller level.

$ PermissionDeniedManager#defaultDeniedTemplateBehaviorProperty in class PermissionDeniedManager

Default behavior for denied permissions at the template level.

$ Mailer#defaultFromProperty in class Mailer

Default "from" address

BackendManager::detachShared() — Method in class BackendManager

Detach from shared event manager.

$ Options#defaultSortProperty in class Options

Overall default sort option

$ Options#defaultSortByHandlerProperty in class Options

Handler-specific defaults

$ Options#defaultHandlerProperty in class Options

Default search handler

$ Options#defaultFiltersProperty in class Options

Default filters to apply to new searches

$ Options#defaultLimitProperty in class Options

Default limit option

$ Options#defaultViewProperty in class Options

Default view option

$ Options#defaultFacetDelimiterProperty in class Options

Default delimiter used for delimited facets

$ Options#delimitedFacetsProperty in class Options

Facet settings

$ Options#defaultSelectedShardsProperty in class Options

Default selected shards

Options::disableHighlighting() — Method in class Options

Turn off highlighting.

$ Params#defaultFacetLabelSectionsProperty in class Params

Config sections to search for facet labels if no override configuration is set.

$ Params#defaultFacetLabelCheckboxSectionsProperty in class Params

Config sections to search for checkbox facet labels if no override configuration is set.

$ Params#defaultsAppliedProperty in class Params

Are default filters applied?

Params::deminify() — Method in class Params

Restore settings from a minified object found in the database.

Results::deminify() — Method in class Results

Restore settings from a minified object found in the database.

$ Options#defaultLimitProperty in class Options

Default limit option

$ Options#defaultViewProperty in class Options

Default view option

$ Options#defaultModeProperty in class Options

Default search mode options

$ Options#defaultExpandersProperty in class Options

Default expanders to apply

$ Params#dateFacetSettingsProperty in class Params

Settings for the date facet only

$ Params#defaultFacetLabelSectionsProperty in class Params

Config sections to search for facet labels if no override configuration is set.

$ Params#defaultFacetLabelCheckboxSectionsProperty in class Params

Config sections to search for checkbox facet labels if no override configuration is set.

QueryAdapter::display() — Method in class QueryAdapter

Convert a Query or QueryGroup into a human-readable display query.

QueryAdapter::displayAdvanced() — Method in class QueryAdapter

Support method for display() -- process advanced queries.

Memory::disable() — Method in class Memory

Stop updating the URL in memory -- used in combined search to prevent multiple search URLs from overwriting one another.

Minified::deminify() — Method in class Minified

Turn the current object into search results.

Params::deminify() — Method in class Params

Restore settings from a minified object found in the database.

$ Params#defaultFacetLabelSectionsProperty in class Params

Config sections to search for facet labels if no override configuration is set.

$ Params#defaultFacetLabelCheckboxSectionsProperty in class Params

Config sections to search for checkbox facet labels if no override configuration is set.

QueryAdapter::deminify() — Method in class QueryAdapter

Return a Query or QueryGroup based on minified search arguments.

QueryAdapter::display() — Method in class QueryAdapter

Convert a Query or QueryGroup into a human-readable display query.

QueryAdapter::displayAdvanced() — Method in class QueryAdapter

Support method for display() -- process advanced queries.

$ Params#defaultFacetLabelSectionsProperty in class Params

Config sections to search for facet labels if no override configuration is set.

$ Params#defaultFacetLabelSectionsProperty in class Params

Config sections to search for facet labels if no override configuration is set.

$ Params#defaultFacetLabelSectionsProperty in class Params

Config sections to search for facet labels if no override configuration is set.

$ Params#defaultFacetLabelSectionsProperty in class Params

Config sections to search for facet labels if no override configuration is set.

DeduplicationListenerClass in namespace VuFind\Search\Solr

Solr merged record handling listener.

$ DeduplicationListener#dataSourceConfigProperty in class DeduplicationListener

Data source configuration file identifier.

DeduplicationListener::determineSourcePriority() — Method in class DeduplicationListener

Function that determines the priority for sources

DeduplicationListener::determineBuildingPriority() — Method in class DeduplicationListener

Function that determines the priority for buildings

DefaultParametersListenerClass in namespace VuFind\Search\Solr

Solr default parameters listener.

$ DefaultParametersListener#defaultParamsProperty in class DefaultParametersListener

Default parameteres

$ HierarchicalFacetListener#displayStylesProperty in class HierarchicalFacetListener

Facet display styles.

$ InjectSpellingListener#dictionariesProperty in class InjectSpellingListener

Dictionaries for spellcheck.

$ Options#displayRecordVersionsProperty in class Options

Whether to display record versions

$ Params#defaultFacetLabelSectionsProperty in class Params

Config sections to search for facet labels if no override configuration is set.

$ Params#defaultFacetLabelCheckboxSectionsProperty in class Params

Config sections to search for checkbox facet labels if no override configuration is set.

SpellingProcessor::doSingleReplace() — Method in class SpellingProcessor

Process one instance of a spelling replacement and modify the return data structure with the details of what was done.

$ Params#dateFacetSettingsProperty in class Params

Settings for the date facet only

$ Params#defaultFacetLabelSectionsProperty in class Params

Config sections to search for facet labels if no override configuration is set.

$ Params#defaultFacetLabelCheckboxSectionsProperty in class Params

Config sections to search for checkbox facet labels if no override configuration is set.

$ Results#databaseRecommendationsProperty in class Results

Database recommendations

$ AbstractPluginFactory#defaultNamespaceProperty in class AbstractPluginFactory

Default namespace for building class names

$ CurrencyFormatter#defaultCurrencyProperty in class CurrencyFormatter

Default currency format (ISO 4217) to use.

DateConverterFactoryClass in namespace VuFind\Service

Factory for \VuFind\Date\Converter

$ MarkdownFactory#defaultExtensionsProperty in class MarkdownFactory

Default set of extensions

AbstractBase::disableWrites() — Method in class AbstractBase

Disable session writing, i.e. make it read-only

AbstractBase::destroy() — Method in class AbstractBase

The destroy handler, this is executed when a session is destroyed with session_destroy() and takes the session id as its only parameter.

DatabaseClass in namespace VuFind\Session

Database session handler

Database::destroy() — Method in class Database

The destroy handler, this is executed when a session is destroyed with session_destroy() and takes the session id as its only parameter.

File::destroy() — Method in class File

The destroy handler, this is executed when a session is destroyed with session_destroy() and takes the session id as its only parameter.

HandlerInterface::disableWrites() — Method in class HandlerInterface

Disable session writing, i.e. make it read-only

Memcache::destroy() — Method in class Memcache

The destroy handler, this is executed when a session is destroyed with session_destroy() and takes the session id as its only parameter.

$ PluginManager#delegatorsProperty in class PluginManager

Default delegator factories.

Redis::destroy() — Method in class Redis

The destroy handler, this is executed when a session is destroyed with session_destroy() and takes the session id as its only parameter.

SecureDelegatorFactory::delegate() — Method in class SecureDelegatorFactory

Creates the delegating session handler

$ Settings#disableWriteProperty in class Settings

Have session writes been disabled?

Settings::disableWrite() — Method in class Settings

Disable session writes after this point in time.

$ CursorMarkIdFetcher#defaultParamsProperty in class CursorMarkIdFetcher

Default parameters to send to Solr with each request

Writer::deleteAll() — Method in class Writer

Delete all records in the index.

Writer::deleteByQuery() — Method in class Writer

Delete records based on a Solr query.

Writer::deleteRecords() — Method in class Writer

Delete an array of IDs from the specified search backend

DatabaseClass in namespace VuFind\UrlShortener

Local database-driven URL shortener.

DatabaseFactoryClass in namespace VuFind\UrlShortener

Factory for local database-driven URL shortener.

$ Citation#detailsProperty in class Citation

Citation details

$ Citation#driverProperty in class Citation

Record driver

$ Citation#dateConverterProperty in class Citation

Date converter

$ CookieConsent#dateConverterProperty in class CookieConsent

Date converter

Csp::disablePolicy() — Method in class Csp

Disable Content Security Policy by removing the headers

DateTimeClass in namespace VuFind\View\Helper\Root

View helper for formatting dates and times

DateTimeFactoryClass in namespace VuFind\View\Helper\Root

DateTime helper factory.

DisplayLanguageOptionClass in namespace VuFind\View\Helper\Root

DisplayLanguageOption view helper

DisplayLanguageOptionFactoryClass in namespace VuFind\View\Helper\Root

DisplayLanguageOption helper factory.

DoiClass in namespace VuFind\View\Helper\Root

DOI view helper

DoiFactoryClass in namespace VuFind\View\Helper\Root

DOI helper factory.

$ Icon#defaultSetProperty in class Icon

Default icon set

$ Icon#defaultTemplateProperty in class Icon

Default icon template

$ LocalizedNumber#defaultDecimalPointProperty in class LocalizedNumber

Default decimal point character

$ LocalizedNumber#defaultThousandSepProperty in class LocalizedNumber

Default thousands separator character

$ MakeTag#deprecatedElementsProperty in class MakeTag

List of deprecated elements that should be replaced.

$ Matomo#disableCookiesProperty in class Matomo

Whether to disable cookies (see config.ini for details)

$ Piwik#disableCookiesProperty in class Piwik

Whether to disable cookies (see config.ini for details)

$ Record#driverProperty in class Record

Record driver

Record::deduplicateLinks() — Method in class Record

Remove duplicates from the array. All keys and values are being used recursively to compare, so if there are 2 links with the same url but different desc, they will both be preserved.

$ RecordDataFormatter#defaultsProperty in class RecordDataFormatter

Default settings.

$ RecordDataFormatter#driverProperty in class RecordDataFormatter

Record driver object.

VuFindWorkKeys::deDom() — Method in class VuFindWorkKeys

Force a value to a string, even if it's a DOMElement.

E

ClearCacheCommand::execute() — Method in class ClearCacheCommand

Run the command.

ExpireCsrfTokensCommandClass in namespace KnihovnyCzConsole\Command\Util

Class ExpireCsrfTokensCommand

ExpireCsrfTokensCommandFactoryClass in namespace KnihovnyCzConsole\Command\Util

Class ExpireCsrfTokensCommandFactory

ExpireUsersCommandClass in namespace KnihovnyCzConsole\Command\Util

Class Users

ExpireUsersCommandFactoryClass in namespace KnihovnyCzConsole\Command\Util

Class ExpireUsersCommandFactory

UpdateResourcesFromSolrCommand::execute() — Method in class UpdateResourcesFromSolrCommand

Run the command.

Cronjob::expireUsersAction() — Method in class Cronjob

Expire users endpoint

Cronjob::expireCsrfTokensAction() — Method in class Cronjob

Expire csrf tokens endpoint

Cronjob::expireSearchesAction() — Method in class Cronjob

Expire searches endpoint

EddClass in namespace KnihovnyCz\AjaxHandler

Class Edd - API for electronic document delivery

EddFactoryClass in namespace KnihovnyCz\AjaxHandler

Class EddFactory - API for electronic document delivery

Sfx::extractParameters() — Method in class Sfx

Extract query parameters from URL

SolrAuthorityEnricher::enrich() — Method in class SolrAuthorityEnricher

Enrich authors with link to authority record

$ SuggestionFilter#escapeHtmlProperty in class SuggestionFilter

Helper for escaping HTML

EmbeddedControllerClass in namespace KnihovnyCz\Controller

Class EmbeddedController

$ MyResearchTrait#EXCEPTIONS_TO_SHOWProperty in class MyResearchTrait
SearchController::embeddedAction() — Method in class SearchController

Show embedded search for use in HTML iframe

$ User#emailProperty in class User
$ User#email_verifiedProperty in class User
$ UserCard#eppnProperty in class UserCard
CsrfToken::expirationCallback() — Method in class CsrfToken

Update the select statement to find records to delete.

User::expirationCallback() — Method in class User

Update the select statement to find records to delete.

Aleph::extractHoldingInfoForItem() — Method in class Aleph

Extract holdings for items from XML response

Aleph::extractShortLoanInfoForItem() — Method in class Aleph

Extract short loan info for items from XML response

EDSClass in namespace KnihovnyCz\RecordDriver

Knihovny.cz EDS record driver

EdsFactoryClass in namespace KnihovnyCz\RecordDriver

Class EdsFactory

$ SolrAuthority#externalLinksProperty in class SolrAuthority
SolrLocal::extractYear() — Method in class SolrLocal

Try to extract year from 996|y in holdings

SolrLocal::extractVolume() — Method in class SolrLocal

Try to extract volume from 996|v in hodings

EVersionClass in namespace KnihovnyCz\RecordTab

Class EVersion

EdsBackendFactoryClass in namespace KnihovnyCz\Search\Factory

Factory for the default EDS backend.

$ JsonFacetListener#enabledForAllFacetsProperty in class JsonFacetListener

Use JSON API for all facets

$ JsonFacetListener#enabledProperty in class JsonFacetListener

Is enabled?

$ MultiplyingDeduplicationListener#enabledProperty in class MultiplyingDeduplicationListener

Whether deduplication is enabled.

NullSessionManager::expireSessionCookie() — Method in class NullSessionManager

Expire the session cookie

EscapeElementIdClass in namespace KnihovnyCz\View\Helper\KnihovnyCz

Escape element id View Helper

ConfigController::enableautoconfigAction() — Method in class ConfigController

Support action for config -- attempt to enable auto configuration.

MaintenanceController::expire() — Method in class MaintenanceController

Abstract delete method.

ThemeCommand::execute() — Method in class ThemeCommand

Run the command.

$ AbstractThemeCommand#extraSuccessMessageProperty in class AbstractThemeCommand

Extra text to append to the output when generation is successful.

AbstractThemeCommand::execute() — Method in class AbstractThemeCommand

Run the command.

DynamicRouteCommand::execute() — Method in class DynamicRouteCommand

Run the command.

ExtendClassCommandClass in namespace VuFindConsole\Command\Generate

Console command: extend class.

ExtendClassCommand::execute() — Method in class ExtendClassCommand

Run the command.

ExtendServiceCommandClass in namespace VuFindConsole\Command\Generate

Console command: extend service.

ExtendServiceCommand::execute() — Method in class ExtendServiceCommand

Run the command.

NonTabRecordActionCommand::execute() — Method in class NonTabRecordActionCommand

Run the command.

PluginCommand::execute() — Method in class PluginCommand

Run the command.

RecordRouteCommand::execute() — Method in class RecordRouteCommand

Run the command.

StaticRouteCommand::execute() — Method in class StaticRouteCommand

Run the command.

$ ThemeMixinCommand#extraSuccessMessageProperty in class ThemeMixinCommand

Extra text to append to the output when generation is successful.

HarvestOaiCommand::execute() — Method in class HarvestOaiCommand

Run the command.

MergeMarcCommand::execute() — Method in class MergeMarcCommand

Run the command.

ImportCsvCommand::execute() — Method in class ImportCsvCommand

Run the command.

ImportXslCommand::execute() — Method in class ImportXslCommand

Run the command.

WebCrawlCommand::execute() — Method in class WebCrawlCommand

Run the command.

InstallCommand::execute() — Method in class InstallCommand

Run the command.

AbstractCommand::extractTextDomain() — Method in class AbstractCommand

Extract a text domain and key from a raw language key.

AddUsingTemplateCommand::execute() — Method in class AddUsingTemplateCommand

Run the command.

CopyStringCommand::execute() — Method in class CopyStringCommand

Run the command.

DeleteCommand::execute() — Method in class DeleteCommand

Run the command.

NormalizeCommand::execute() — Method in class NormalizeCommand

Run the command.

NotifyCommand::err() — Method in class NotifyCommand

Display an error.

NotifyCommand::execute() — Method in class NotifyCommand

Run the command.

AbstractCssBuilderCommand::execute() — Method in class AbstractCssBuilderCommand

Run the command.

AbstractExpireCommand::execute() — Method in class AbstractExpireCommand

Run the command.

CleanUpRecordCacheCommand::execute() — Method in class CleanUpRecordCacheCommand

Run the command.

CommitCommand::execute() — Method in class CommitCommand

Run the command.

CreateHierarchyTreesCommand::execute() — Method in class CreateHierarchyTreesCommand

Run the command.

DedupeCommand::execute() — Method in class DedupeCommand

Run the command.

DeletesCommand::execute() — Method in class DeletesCommand

Run the command.

ExpireAccessTokensCommandClass in namespace VuFindConsole\Command\Util

Console command: expire access tokens.

ExpireAccessTokensCommandFactoryClass in namespace VuFindConsole\Command\Util

Factory for Util/ExpireAccessTokensCommand.

ExpireAuthHashesCommandClass in namespace VuFindConsole\Command\Util

Console command: expire authentication hashes.

ExpireAuthHashesCommandFactoryClass in namespace VuFindConsole\Command\Util

Factory for Util/ExpireAuthHashesCommand.

ExpireExternalSessionsCommandClass in namespace VuFindConsole\Command\Util

Console command: expire sessions.

ExpireExternalSessionsCommandFactoryClass in namespace VuFindConsole\Command\Util

Factory for Util/ExpireExternalSessionsCommand.

ExpireSearchesCommandClass in namespace VuFindConsole\Command\Util

Console command: expire searches.

ExpireSearchesCommandFactoryClass in namespace VuFindConsole\Command\Util

Factory for Util/ExpireSearchesCommand.

ExpireSessionsCommandClass in namespace VuFindConsole\Command\Util

Console command: expire sessions.

ExpireSessionsCommandFactoryClass in namespace VuFindConsole\Command\Util

Factory for Util/ExpireSessionsCommand.

IndexReservesCommand::execute() — Method in class IndexReservesCommand

Run the command.

LintMarcCommand::execute() — Method in class LintMarcCommand

Run the command.

OptimizeCommand::execute() — Method in class OptimizeCommand

Run the command.

SitemapCommand::execute() — Method in class SitemapCommand

Run the command.

SuppressedCommand::execute() — Method in class SuppressedCommand

Run the command.

SwitchDbHashCommand::execute() — Method in class SwitchDbHashCommand

Run the command.

GeneratorTools::extendClass() — Method in class GeneratorTools

Extend a class defined somewhere in the service manager or its child plugin managers.

GeneratorTools::extendService() — Method in class GeneratorTools

Extend a service defined in module.config.php.

$ Backend#eventsProperty in class Backend

Event manager.

$ RecordCollection#errorsProperty in class RecordCollection

Any errors encountered

$ Base#edsApiHostProperty in class Base

EDSAPI host

$ SearchRequestModel#expandersProperty in class SearchRequestModel

Expanders to use. Comma separated.

SearchRequestModel::endsWith() — Method in class SearchRequestModel

Verify whether or not a string ends with certain characters

SearchRequestModel::escapeSpecialCharacters() — Method in class SearchRequestModel

Escape characters that may be present in the parameter syntax

SearchRequestModel::escapeSpecialCharactersForActions() — Method in class SearchRequestModel

Escape characters that may be present in the action parameter syntax

$ Connector#emptyQueryResponseProperty in class Connector

Response for an empty search

$ RawDocument#encodingProperty in class RawDocument

Text encoding

LuceneSyntaxHelper::extractSearchTerms() — Method in class LuceneSyntaxHelper

Extract search terms from a query string for spell checking.

$ QueryBuilder#exactSpecsProperty in class QueryBuilder

Search specs for exact searches.

$ AbstractBase#executedProperty in class AbstractBase

Was the command executed?

CallMethodCommand::execute() — Method in class CallMethodCommand

Execute command on backend.

CommandInterface::execute() — Method in class CommandInterface

Execute command on backend.

GetIdsCommand::execute() — Method in class GetIdsCommand

Execute command on backend.

GetLuceneHelperCommand::execute() — Method in class GetLuceneHelperCommand

Execute command on backend.

GetQueryBuilderCommand::execute() — Method in class GetQueryBuilderCommand

Execute command on backend.

GetUniqueKeyCommand::execute() — Method in class GetUniqueKeyCommand

Execute command on backend.

RandomCommand::execute() — Method in class RandomCommand

Execute command on backend.

RetrieveBatchCommand::execute() — Method in class RetrieveBatchCommand

Execute command on backend.

WorkExpressionsCommand::execute() — Method in class WorkExpressionsCommand

Execute command on backend.

ExceptionInterfaceClass in namespace VuFindSearch\Exception

Marker interface.

ParamBag::exchangeArray() — Method in class ParamBag

Exchange the parameter array.

$ Service#eventsProperty in class Service

Event manager.

EdsTestClass in namespace VuFindTest\Autocomplete

Eds autocomplete test class.

LuceneSyntaxHelperTest::extractSearchTermsProvider() — Method in class LuceneSyntaxHelperTest

Data provider for testExtractSearchTerms.

ExtendClassCommandTestClass in namespace VuFindTest\Command\Generate

Generate/ExtendClass command test.

ExtendServiceCommandTestClass in namespace VuFindTest\Command\Generate

Generate/ExtendService command test.

$ AbstractExpireCommandTest#expectedMinAgeProperty in class AbstractExpireCommandTest

Expected minimum age in error message.

ExpireAuthHashesCommandTestClass in namespace VuFindTest\Command\Util

ExpireAuthHashesCommand test.

ExpireExternalSessionsCommandTestClass in namespace VuFindTest\Command\Util

ExpireExternalSessionsCommand test.

ExpireSearchesCommandTestClass in namespace VuFindTest\Command\Util

ExpireSearchesCommand test.

ExpireSessionsCommandTestClass in namespace VuFindTest\Command\Util

ExpireSessionsCommand test.

$ ExpireSessionsCommandTest#expectedMinAgeProperty in class ExpireSessionsCommandTest

Expected minimum age in error message.

$ SwitchDbHashCommandTest#expectedConfigIniPathProperty in class SwitchDbHashCommandTest

Expected path to config.ini

$ SwitchDbHashCommandTest#encryptionAlgorithmProperty in class SwitchDbHashCommandTest

Encryption algorithm to use

Base62Test::exampleProvider() — Method in class Base62Test

Data provider for tests.

CssPreCompilerTest::extClassProvider() — Method in class CssPreCompilerTest

Data Provider for extensions and classes

ExportTestClass in namespace VuFindTest

Export Support Test Class

EmailTestClass in namespace VuFindTest\Form\Handler

Email Form Handler Test Class

ExtendedIniNormalizerTestClass in namespace VuFindTest\I18n

ExtendedIniNormalizer Test Class

ExtendedIniReaderTestClass in namespace VuFindTest\I18n\Translator\Loader

ExtendedIniReader Test Class

ExtendedIniTestClass in namespace VuFindTest\I18n\Translator\Loader

ExtendedIni translation loader Test Class

EvergreenTestClass in namespace VuFindTest\ILS\Driver

ILS driver test

$ GeniePlusTest#expectedLoginRequestProperty in class GeniePlusTest

Expected parameters to patron login request

$ GeniePlusTest#expectedTokenRequestProperty in class GeniePlusTest

Expected parameters to token generation request

ExampleExtensionClass in namespace VuFindTest\Markdown

Class ExampleExtension

EprintsTestClass in namespace VuFindTest\MetadataVocabulary

Eprints Test Class

AdvancedSearchTest::editAdvancedSearch() — Method in class AdvancedSearchTest

Find the "edit advanced search link" and click it.

EDSResultsDeferredTestClass in namespace VuFindTest\Recommend

EDSResultsDeferred recommendation module Test Class

EuropeanaResultsDeferredTestClass in namespace VuFindTest\Recommend

EuropeanaResultsDeferred recommendation module Test Class

EuropeanaResultsTestClass in namespace VuFindTest\Recommend

EuropeanaResults tests.

ExpandFacetsTestClass in namespace VuFindTest\Recommend

ExpandFacets recommendation module Test Class

ExternalSearchTestClass in namespace VuFindTest\Recommend

ExternalSearch recommendation module Test Class

EDSTestClass in namespace VuFindTest\RecordDriver

EDS Record Driver Test Class

EITTestClass in namespace VuFindTest\RecordDriver

EIT Record Driver Test Class

ExcerptTestClass in namespace VuFindTest\RecordTab

Excerpt Test Class

$ ParamsTest#edsApiConfigProperty in class ParamsTest

EDS API configuration

$ ParamsTest#edsConfigProperty in class ParamsTest

EDS configuration

$ ConditionalFilterListenerTest#emptySearchConfigProperty in class ConditionalFilterListenerTest

Sample configuration for empty ConditionalFilters config.

ErrorListenerTestClass in namespace VuFindTest\Search\Solr\V3

Unit tests for SOLR 3.x error listener.

ErrorListenerTestClass in namespace VuFindTest\Search\Solr\V4

Unit tests for SOLR 3.x error listener.

$ Initializer#eventProperty in class Initializer

Laminas MVC Event

$ Mobile#enabledProperty in class Mobile

Are mobile themes enabled?

Mobile::enable() — Method in class Mobile

Function to set enabled status of mobile themes.

Mobile::enabled() — Method in class Mobile

Function to check whether mobile theme is configured.

$ ResourceContainer#encodingProperty in class ResourceContainer

Encoding type

ConcatTrait::enabledInConfig() — Method in class ConcatTrait

Check if config is enamled for this file type

Slot::end() — Method in class Slot

End a buffer capture to override the value of a block. Returns slot value.

$ CommentRecord#enabledProperty in class CommentRecord

Are comments enabled?

$ DeleteRecordComment#enabledProperty in class DeleteRecordComment

Are comments enabled?

$ AuthToken#expiresInProperty in class AuthToken

Number of seconds in token expires

Database::exceptionIndicatesDuplicateKey() — Method in class Database

Does the provided exception indicate that a duplicate key value has been created?

Database::emailAllowed() — Method in class Database

Check that an email address is legal based on inclusion list (if configured).

EmailClass in namespace VuFind\Auth

Email authentication module.

$ Email#emailAuthenticatorProperty in class Email

Email Authenticator

EmailAuthenticatorClass in namespace VuFind\Auth

Class for managing email-based authentication.

EmailAuthenticatorFactoryClass in namespace VuFind\Auth

Factory for email authenticator module.

EmailFactoryClass in namespace VuFind\Auth

Factory for Email authentication module.

$ ILS#emailAuthenticatorProperty in class ILS

Email Authenticator

$ ILSAuthenticator#emailAuthenticatorProperty in class ILSAuthenticator

Email authenticator

EdsClass in namespace VuFind\Autocomplete

EDS Autocomplete Module

EdsFactoryClass in namespace VuFind\Autocomplete

Factory for EDS-driven autocomplete plugins. Works for \VuFind\Autocomplete\Eds

$ Bootstrapper#eventProperty in class Bootstrapper

Current MVC event

$ Bootstrapper#eventsProperty in class Bootstrapper

Event manager

$ ImporterConfig#encodingProperty in class ImporterConfig

Input character encoding

$ Interval#errorMessageProperty in class Interval

Verification error message

Cart::emptyCart() — Method in class Cart

Empty the cart.

AbstractILSChannelProvider::extractIdsFromResponse() — Method in class AbstractILSChannelProvider

Given one element from the ILS function's response array, extract the ID value.

NewILSItems::extractIdsFromResponse() — Method in class NewILSItems

Given one element from the ILS function's response array, extract the ID value.

RecentlyReturned::extractIdsFromResponse() — Method in class RecentlyReturned

Given one element from the ILS function's response array, extract the ID value.

TrendingILSItems::extractIdsFromResponse() — Method in class TrendingILSItems

Given one element from the ILS function's response array, extract the ID value.

Upgrade::extractComments() — Method in class Upgrade

Read the specified file and return an associative array of this format containing all comments extracted from the file:

Oracle::exec() — Method in class Oracle

Wrapper around oci_execute.

Wikipedia::extractImageFromInfoBox() — Method in class Wikipedia

Extract image information from an infobox

Wikipedia::extractInfoBox() — Method in class Wikipedia

Support method for parseWikipedia - extract infobox details

Wikipedia::extractImageFromBody() — Method in class Wikipedia

Support method for parseWikipedia - extract first image from body

Wikipedia::extractBodyText() — Method in class Wikipedia

Extract body text

$ ObalkyKnihService#endpointsProperty in class ObalkyKnihService

Array with endpoints, possible endpoints(array keys) are: books, cover, toc, authority, citation, recommend, alive

AbstractRecord::emailAction() — Method in class AbstractRecord

Email action - Allows the email form to appear.

AbstractRecord::exportAction() — Method in class AbstractRecord

Export the record

BrowseController::eraAction() — Method in class BrowseController

Browse Era

CartController::emailAction() — Method in class CartController

Email a batch of records.

CartController::exportAction() — Method in class CartController

Set up export of a batch of records.

EITControllerClass in namespace VuFind\Controller

EIT Controller

EITrecordControllerClass in namespace VuFind\Controller

EIT Record Controller Largely copied from Summon Record Controller

EdsControllerClass in namespace VuFind\Controller

EDS Controller

EdsrecordControllerClass in namespace VuFind\Controller

EDS Record Controller

EdsrecordController::epubAction() — Method in class EdsrecordController

Action to display ePub.

ErrorControllerClass in namespace VuFind\Controller

Error Controller

ExternalAuthControllerClass in namespace VuFind\Controller

External Authentication/Authorization Controller

$ ExternalAuthController#ezproxyRequiredPermissionProperty in class ExternalAuthController

Permission from permissions.ini required for EZProxy authorization.

ExternalAuthController::ezproxyLoginAction() — Method in class ExternalAuthController

Provides an EZproxy session to an authorized user

HoldsController::editAction() — Method in class HoldsController

Edit holds

LibraryCardsController::editCardAction() — Method in class LibraryCardsController

Send user's library card to the edit view

MyResearchController::editAction() — Method in class MyResearchController

Edit record

MyResearchController::editlistAction() — Method in class MyResearchController

Send user's saved favorites from a particular list to the edit view

MyResearchController::emailNotVerifiedAction() — Method in class MyResearchController

Creates a message that the verification email has been sent to the user's mail address.

$ Captcha#errorModeProperty in class Captcha

Flash message or throw Exception

DbUpgrade::explodeFields() — Method in class DbUpgrade

Given a field list extracted from a MySQL table definition (e.g. a,b) return an array of fields (e.g. ['a', 'b']).

$ ResultScroller#enabledProperty in class ResultScroller

Is scroller enabled?

SearchController::editmemoryAction() — Method in class SearchController

Edit search memory action.

SearchController::emailAction() — Method in class SearchController

Email action - Allows the email form to appear.

UpgradeController::errorAction() — Method in class UpgradeController

Display a fatal error message.

UpgradeController::establishversionsAction() — Method in class UpgradeController

Figure out which version(s) are being used.

Base62::encode() — Method in class Base62

Common base62 encoding function.

ExternalSessionClass in namespace VuFind\Db\Row

Row Definition for external_session

$ OaiResumption#expiresProperty in class OaiResumption
$ Resource#extra_metadataProperty in class Resource
$ User#encryptionEnabledProperty in class User

Is encryption enabled?

$ User#encryptionKeyProperty in class User

Encryption key used for catalog passwords (null if encryption disabled):

$ User#emailProperty in class User
$ User#email_verifiedProperty in class User
User::encryptOrDecrypt() — Method in class User

This is a central function for encrypting and decrypting so that logic is all in one location

UserList::editAllowed() — Method in class UserList

Is the current user allowed to edit this list?

AccessToken::expirationCallback() — Method in class AccessToken

Update the select statement to find records to delete.

AuthHash::expirationCallback() — Method in class AuthHash

Update the select statement to find records to delete.

ExpirationTraitClass in namespace VuFind\Db\Table

Trait for tables that support expiration

ExpirationTrait::expirationCallback() — Method in class ExpirationTrait

Update the select statement to find records to delete.

ExternalSessionClass in namespace VuFind\Db\Table

Table Definition for external_session

ExternalSession::expirationCallback() — Method in class ExternalSession

Update the select statement to find records to delete.

Search::expirationCallback() — Method in class Search

Update the select statement to find records to delete.

Session::expirationCallback() — Method in class Session

Update the select statement to find records to delete.

$ Unpaywall#emailProperty in class Unpaywall

E-mail used as parameter when calling API

ExportClass in namespace VuFind

Export support class

$ Export#exportConfigProperty in class Export

Export-specific configuration

ExportFactoryClass in namespace VuFind

Export factory.

EntryClass in namespace VuFind\Feed\Writer\Extension\DublinCore

Laminas\Feed\Entry extension for Dublin Core

EntryClass in namespace VuFind\Feed\Writer\Extension\DublinCore\Renderer

Laminas\Feed\Renderer\Entry extension for Dublin Core

$ Feed#encodingProperty in class Feed

Encoding of all text values

EmailClass in namespace VuFind\Form\Handler

Class Email

EmailFactoryClass in namespace VuFind\Form\Handler

Class EmailFactory

$ AbstractBase#enabledProperty in class AbstractBase

Are trees globally enabled?

ExtendedIniNormalizerClass in namespace VuFind\I18n

Class to consistently format ExtendedIni language files.

ExtendedIniNormalizer::extractComments() — Method in class ExtendedIniNormalizer

Extract comments from an array of lines read from a file.

$ LocaleSettings#enabledLocalesProperty in class LocaleSettings

Associative (code => description) array of enabled locales.

ExtendedIniClass in namespace VuFind\I18n\Translator\Loader

Handles the language loading and language file parsing

ExtendedIniFactoryClass in namespace VuFind\I18n\Translator\Loader

ExtendedIni Loader Factory

ExtendedIniReaderClass in namespace VuFind\I18n\Translator\Loader

Helper class to load .ini files from disk.

TranslatorAwareTrait::extractTextDomain() — Method in class TranslatorAwareTrait

Given a translation string with or without a text domain, return an array with the raw string and the text domain separated.

TranslatorFactory::enableCaching() — Method in class TranslatorFactory

Add caching to a translator object

DAIA::extractDaiaDoc() — Method in class DAIA

Extract a DAIA document identified by an id

EvergreenClass in namespace VuFind\ILS\Driver

VuFind Connector for Evergreen

Folio::escapeCql() — Method in class Folio

Escape a string for use in a CQL query.

GeniePlus::extractDisplayValues() — Method in class GeniePlus

Extract display values from an API response field.

PAIA::enrichUserDetails() — Method in class PAIA

PAIA helper function to map session data to return value of patronLogin()

PAIA::enrichNotifications() — Method in class PAIA

Enriches PAIA notifications response with additional mappings

Polaris::encodeJSONTime() — Method in class Polaris

Encode from human-readable date to text like Date(1360051200000-0800)

SierraRest::extractId() — Method in class SierraRest

Extract an ID from a URL (last number)

SierraRest::extractVolume() — Method in class SierraRest

Extract volume from item record's varFields

SierraRest::extractFieldsFromApiData() — Method in class SierraRest

Get fields from holdings or bib API response according to the field spec.

SierraRest::extractBibId() — Method in class SierraRest

Extract a numeric bib ID value from a string that may be prefixed.

Voyager::executeSQL() — Method in class Voyager

Execute an SQL query

$ VoyagerRestful#excludedItemLocationsProperty in class VoyagerRestful

Item locations exluded from item availability check.

VoyagerRestful::encodeXML() — Method in class VoyagerRestful

Encode a string for XML

VoyagerRestful::extractBlockReasons() — Method in class VoyagerRestful

Given the appropriate portion of the blocks API response, extract a list of block reasons that VuFind is not configured to ignore.

XCNCIP2::element() — Method in class XCNCIP2

Creates simple element as XML string

EprintsClass in namespace VuFind\MetadataVocabulary

Metadata vocabulary implementation for Eprints

$ Server#earliestDatestampProperty in class Server

Earliest datestamp used in "Identify" response

$ AbstractTokenRepository#entityClassProperty in class AbstractTokenRepository

Entity class

$ AbstractFacets#excludableFacetsProperty in class AbstractFacets

Facets with "exclude" links enabled

AbstractFacets::excludeAllowed() — Method in class AbstractFacets

Is the specified field allowed to be excluded?

$ DOI#exactProperty in class DOI

Does the DOI in $match exactly match the user's query?

EDSResultsClass in namespace VuFind\Recommend

EDSResults Recommendations Module

EDSResultsDeferredClass in namespace VuFind\Recommend

EDSResultsDeferred Recommendations Module

EuropeanaResultsClass in namespace VuFind\Recommend

EuropeanaResults Recommendations Module

$ EuropeanaResults#excludeProvidersProperty in class EuropeanaResults

Providers to exclude

EuropeanaResultsDeferredClass in namespace VuFind\Recommend

EuropeanaResultsDeferred Recommendations Module

EuropeanaResultsFactoryClass in namespace VuFind\Recommend

EuropeanaResults recommendation module factory.

ExpandFacetsClass in namespace VuFind\Recommend

Recommendation class to expand recommendation interfaces

$ ExpandFacets#emptyResultsProperty in class ExpandFacets

Empty result set (used by the template as the basis for URL generation)

ExpandFacetsFactoryClass in namespace VuFind\Recommend

ExpandFacets recommendation module factory.

ExternalSearchClass in namespace VuFind\Recommend

ExternalSearch Recommendation Module

$ AbstractBase#extraDetailsProperty in class AbstractBase

For storing extra data with record

EDSClass in namespace VuFind\RecordDriver

Model for EDS records.

$ EDS#epubTypesProperty in class EDS

Document types that are treated as ePub links.

EDS::extractEbscoData() — Method in class EDS

Extract data from EBSCO API response using a prioritized list of selectors.

EDS::extractEbscoDataFromItems() — Method in class EDS

Extract data from the record's "Items" array, based on a label.

EDS::extractEbscoDataFromRecordInfo() — Method in class EDS

Extract data from the record's "RecordInfo" array, based on a path.

EITClass in namespace VuFind\RecordDriver

Model for records retrieved via EBSCO's EIT API.

MarcAdvancedTrait::extractSingleMarcDetail() — Method in class MarcAdvancedTrait

Support method for getFormattedMarcDetails() -- extract a single result

Primo::exportDisabled() — Method in class Primo

Indicate whether export is disabled for a particular format.

ExcerptClass in namespace VuFind\RecordTab

Excerpt tab

ExcerptFactoryClass in namespace VuFind\RecordTab

Factory for building Excerpt tab.

$ Formats#enabledProperty in class Formats

Is this tab enabled?

$ UserComments#enabledProperty in class UserComments

Is this tab enabled?

Router::extractSourceAndId() — Method in class Router

Extract source and ID from a pipe-delimited string, adding a default source if appropriate.

$ CsvReader#errorsProperty in class CsvReader

Error messages collected during loading.

Connection::enableCache() — Method in class Connection

Enable caching.

$ Params#extraFacetLabelsProperty in class Params

Extra facet labels

$ Results#errorsProperty in class Results

Any errors reported by the search backend

$ Options#expanderOptionsProperty in class Options

Available expander options

$ Params#extraFilterListProperty in class Params

Additional filters to display as side facets

EITBackendFactoryClass in namespace VuFind\Search\Factory

Factory for EIT backends.

EdsBackendFactoryClass in namespace VuFind\Search\Factory

Factory for EDS backends.

$ EdsBackendFactory#edsConfigProperty in class EdsBackendFactory

EDS configuration

$ Minified#exProperty in class Minified

Extra data (not used by default)

$ SearchRunner#eventsProperty in class SearchRunner

Event manager.

SearchTabsHelper::extractClassName() — Method in class SearchTabsHelper

Extract search class name from a tab id

$ DeduplicationListener#enabledProperty in class DeduplicationListener

Whether deduplication is enabled.

$ Options#emptySearchRelevanceOverrideProperty in class Options

Relevance sort override for empty searches

$ SpellingProcessor#expandProperty in class SpellingProcessor

Offer expansions on terms as well as basic replacements?

ErrorListenerClass in namespace VuFind\Search\Solr\V3

SOLR 3.x error listener.

ErrorListenerClass in namespace VuFind\Search\Solr\V4

SOLR 3.x error listener.

$ Options#emptySearchRelevanceOverrideProperty in class Options

Relevance sort override for empty searches

$ MarkdownFactory#extensionsProperty in class MarkdownFactory

Enabled extensions

AbstractBase::enableWrites() — Method in class AbstractBase

Enable session writing (default)

HandlerInterface::enableWrites() — Method in class HandlerInterface

Enable session writing (default)

$ ContentPages#excludedFilesProperty in class ContentPages

Files to be ignored when searching for content pages

AlphaBrowse::escapeForSolr() — Method in class AlphaBrowse

Escape a string for inclusion in a Solr query.

DateTime::extractYear() — Method in class DateTime

Extract a year from a human-readable date. Return false if no year can be found.

ExportClass in namespace VuFind\View\Helper\Root

Export view helper

$ Export#exportProperty in class Export

VuFind Export Tools

ExportFactoryClass in namespace VuFind\View\Helper\Root

Export helper factory.

$ GeoCoords#enabledProperty in class GeoCoords

Is Map Search enabled?

$ Highlight#endTagProperty in class Highlight

End tag for highlighitng

$ Icon#escProperty in class Icon

Escape helper

RecordDataFormatter::extractData() — Method in class RecordDataFormatter

Extract data (usually from the record driver).

$ SafeMoneyFormat#escapeHtmlProperty in class SafeMoneyFormat

Escape helper

$ SystemEmail#emailProperty in class SystemEmail

System email

VuFind::explode() — Method in class VuFind

Proxy the explode PHP function for use in XSL transformation.

VuFind::extractBestDateOrRange() — Method in class VuFind

Try to find the best single year or date range in a set of DOM elements.

VuFind::extractEarliestYear() — Method in class VuFind

Try to find a four-digit year in a set of DOM elements.

F

$ XCNCIP2Test#finesTestsProperty in class XCNCIP2Test
$ SolrAuthorityEnricher#filterProperty in class SolrAuthorityEnricher

Filter to apply when enriching results from autocomplete

$ SolrPrefixHandler#facetFieldProperty in class SolrPrefixHandler

Facet field

$ SolrPrefixHandler#filtersProperty in class SolrPrefixHandler

Filters to apply to Solr search

$ SolrPrefixSorted#facetFieldProperty in class SolrPrefixSorted

Facet field

$ SolrPrefixSorted#filtersProperty in class SolrPrefixSorted

Filters to apply to Solr search

SuggestionFilter::filter() — Method in class SuggestionFilter

Filter suggestions and apply highlightin

$ AbstractDbAwaredRecordIds#facetFieldProperty in class AbstractDbAwaredRecordIds

Facet field

$ DocumentTypes#facetFieldProperty in class DocumentTypes

Facet field

HoldsController::flashRedirect() — Method in class HoldsController

Flash redirect controller plugin

MyResearchController::finesAction() — Method in class MyResearchController

Send list of fines to view

MyResearchController::finesAjaxAction() — Method in class MyResearchController

Send list of fines to view as HTML for rendering in AJAX

MyResearchController::finesPaymentAction() — Method in class MyResearchController

Action for finished payment

MyResearchController::flashRedirect() — Method in class MyResearchController

Flash redirect controller plugin

MyResearchZiskejEddController::flashRedirect() — Method in class MyResearchZiskejEddController

Flash redirect controller plugin

MyResearchZiskejMvsController::flashRedirect() — Method in class MyResearchZiskejMvsController

Flash redirect controller plugin

FlashRedirectClass in namespace KnihovnyCz\Controller\Plugin

VuFind Flash Redirect

ResultScroller::fetchPage() — Method in class ResultScroller

Fetch the given page of results from the given search object and return the IDs of the records in an array.

ShortLoans::fillSlots() — Method in class ShortLoans

Fill empty slots

RecordController::flashMessenger() — Method in class RecordController
ZiskejController::finishedAction() — Method in class ZiskejController

Ziskej order finished page

$ User#firstnameProperty in class User
CsrfToken::findBySessionAndHash() — Method in class CsrfToken

Retrieve a user object from the database based on eduPersonUniqueId or create new one.

Resource::findAll() — Method in class Resource

Return all resources.

$ KohaRest1905#finesMappingsProperty in class KohaRest1905

Fines and charges mappings

MapSelection::fetchDataFromSearchService() — Method in class MapSelection

Fetch details from search service

WikidataTrait::formatLinks() — Method in class WikidataTrait

Format links using wikidata formatters

$ SolrLibrary#facetsConfigProperty in class SolrLibrary

Facets configuration

Summon::fixOpenAccessLink() — Method in class Summon

Fix Open access link

$ Loader#filterChildRecordsProperty in class Loader

Filter child records

$ PerformanceLogger#fileProperty in class PerformanceLogger
Request
$ ChildDocDeduplicationListener#fieldListProperty in class ChildDocDeduplicationListener

Field list to fetch from Solr

ChildDocDeduplicationListener::fetchLocalRecords() — Method in class ChildDocDeduplicationListener

Fetch local records for all the found dedup records

$ DeduplicationListener#facetConfigProperty in class DeduplicationListener

Facet configuration file id

DeduplicationListener::fetchLocalRecords() — Method in class DeduplicationListener

Fetch local records for all the found dedup records

$ JsonFacetListener#facetMethodProperty in class JsonFacetListener

Facet method to use

$ MultiplyingDeduplicationListener#facetsProperty in class MultiplyingDeduplicationListener

Results facets

MultiplyingDeduplicationListener::fetchLocalRecords() — Method in class MultiplyingDeduplicationListener

Fetch local records for all the found dedup records

OneChildDocDeduplicationListener::fetchLocalRecords() — Method in class OneChildDocDeduplicationListener

Fetch local records for all the found dedup records

Params::formatFilterListEntry() — Method in class Params

Format a single filter for use in getFilterList().

NullSessionManager::forgetMe() — Method in class NullSessionManager

Set a 0s TTL for the session cookie

FooterLinkClass in namespace KnihovnyCz\View\Helper\KnihovnyCz

Class FooterLink

SplitText::first() — Method in class SplitText

Return first part of text

TextFormatter::formatArray() — Method in class TextFormatter

Format array

TextFormatter::formatString() — Method in class TextFormatter

Format string

SparqlService::formatPrefixes() — Method in class SparqlService

Format prefixes needed for query

FeedbackControllerClass in namespace VuFindAdmin\Controller

Class FeedbackController

$ SearchApiController#facetFormatterProperty in class SearchApiController

Facet formatter

BaseFormatter::filterArrayValues() — Method in class BaseFormatter

Recursive function to filter array fields:

  • remove empty values
  • convert boolean values to 0/1
  • force numerically indexed (non-associative) arrays to have numeric keys.
FacetFormatterClass in namespace VuFindApi\Formatter

Facet formatter for API responses

FacetFormatter::format() — Method in class FacetFormatter

Create the result facet list

RecordFormatter::format() — Method in class RecordFormatter

Format the results.

MergeMarcCommand::findXmlFiles() — Method in class MergeMarcCommand

Find all XML files in a directory; return a sorted list.

InstallCommand::failWithError() — Method in class InstallCommand

Display an error message and return a failure status.

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ AbstractCssBuilderCommand#formatProperty in class AbstractCssBuilderCommand

Name of precompiler format

$ ScssBuilderCommand#formatProperty in class ScssBuilderCommand

Name of precompiler format

LanguageHelper::findMissingLanguageStrings() — Method in class LanguageHelper

Find strings that are absent from a language file.

Backend::fillMergedCollection() — Method in class Backend

Add records to the merged collection in a round-robin fashion up to the specified limit

RecordCollectionFactory::factory() — Method in class RecordCollectionFactory

Return record collection.

$ RecordCollection#facetFieldsProperty in class RecordCollection

Facet fields.

RecordCollectionFactory::factory() — Method in class RecordCollectionFactory

Return record collection.

$ SearchRequestModel#facetFiltersProperty in class SearchRequestModel

Array of filters to apply to the search

SearchRequestModel::formatDateLimiter() — Method in class SearchRequestModel

Format a date limiter

RecordCollectionFactory::factory() — Method in class RecordCollectionFactory

Return record collection.

RecordCollectionFactory::factory() — Method in class RecordCollectionFactory

Return record collection.

RecordCollectionFactory::factory() — Method in class RecordCollectionFactory

Return record collection.

RecordCollectionFactory::factory() — Method in class RecordCollectionFactory

Return record collection.

RawJsonSearchCommand::finalizeExecution() — Method in class RawJsonSearchCommand

Save a result, flag the command as executed, and return the command object; useful as the final step in execute() implementations.

Connector::forceToBackendException() — Method in class Connector

If an unexpected exception type was received, wrap it in a generic BackendException to standardize upstream handling.

$ HandlerMap#fallbackProperty in class HandlerMap

Fallback handler, if any.

$ QueryBuilder#fieldsToHighlightProperty in class QueryBuilder

Solr fields to highlight. Also serves as a flag for whether to perform highlight-specific behavior; if the field list is empty, highlighting is skipped.

QueryBuilder::fixTrailingQuestionMarks() — Method in class QueryBuilder

If the query ends in a non-escaped question mark, the user may not really intend to use the question mark as a wildcard -- let's account for that possibility.

$ SerializableRecord#fieldsProperty in class SerializableRecord

Record fields

$ Record#fieldsProperty in class Record

SOLR fields.

$ RecordCollection#facetFieldsProperty in class RecordCollection

Facet fields.

RecordCollectionFactory::factory() — Method in class RecordCollectionFactory

Return record collection.

RecordCollectionFactory::factory() — Method in class RecordCollectionFactory

Return record collection.

RecordCollectionFactory::factory() — Method in class RecordCollectionFactory

Return record collection.

AbstractBase::finalizeExecution() — Method in class AbstractBase

Save a result, flag the command as executed, and return the command object; useful as the final step in execute() implementations.

$ AlphabeticBrowseCommand#fromProperty in class AlphabeticBrowseCommand

Starting point for browse results.

$ SetRecordCollectionFactoryCommand#factoryProperty in class SetRecordCollectionFactoryCommand

Factory to set.

$ TermsCommand#fieldProperty in class TermsCommand

Index field.

AbstractRecordCollection::first() — Method in class AbstractRecordCollection

Return first record in response.

RecordCollectionFactoryInterface::factory() — Method in class RecordCollectionFactoryInterface

Convert a response into a record collection.

RecordCollectionInterface::first() — Method in class RecordCollectionInterface

Return first record in collection.

$ SimpleRecord#fieldsProperty in class SimpleRecord

Field data

$ PluginFactoryTest#factoryProperty in class PluginFactoryTest

Plugin factory instance.

FollowupTestClass in namespace VuFindTest\Controller\Plugin

Followup controller plugin tests.

$ AutoRetryTrait#failedAfterRetriesProperty in class AutoRetryTrait

Flag whether we ran out of retries on a prior test.

FixtureTraitClass in namespace VuFindTest\Feature

Trait adding functionality for loading fixtures.

LiveDatabaseTrait::failIfDataExists() — Method in class LiveDatabaseTrait

Static setup support function to fail if there is already data in the database. We want to ensure a clean state for each test!

UserCreationTrait::fillInAccountForm() — Method in class UserCreationTrait

Mink support function: fill in the account creation form.

UserCreationTrait::fillInLoginForm() — Method in class UserCreationTrait

Mink support function: fill in the login form.

UserCreationTrait::fillInChangePasswordForm() — Method in class UserCreationTrait

Mink support function: fill in the change password form.

FeedTestClass in namespace VuFindTest\Feed\Writer\Extension\OpenSearch

OpenSearch Feed Plugin Test Class

FormTestClass in namespace VuFindTest\Form

Form Test Class

FacetFormatterTestClass in namespace VuFindTest\Formatter

Unit tests for facet formatter.

FolioTestClass in namespace VuFindTest\ILS\Driver

ILS driver test

$ PAIATest#feeTestResultProperty in class PAIATest
$ XCNCIP2Test#finesTestsProperty in class XCNCIP2Test

Test definition for testGetMyFines

MinkTestCase::findCss() — Method in class MinkTestCase

Wait for an element to exist, then retrieve it.

MinkTestCase::findCssAndSetValue() — Method in class MinkTestCase

Set a value within an element selected via CSS; retry if set fails due to browser bugs.

MinkTestCase::findAndAssertLink() — Method in class MinkTestCase

Retrieve a link and assert that it exists before returning it.

FakeDriverTraitClass in namespace VuFindTest\MetadataVocabulary

Trait containing method to generate fake drivers for metadata testing.

FavoritesTestClass in namespace VuFindTest\Mink

Mink favorites test class.

FeedbackTestClass in namespace VuFindTest\Mink

Mink Feedback module test class.

FeedbackTest::fillInAndSubmitFeedbackForm() — Method in class FeedbackTest

Fill in the feedback form.

SearchFacetsTest::facetApplyProcedure() — Method in class SearchFacetsTest

Helper function for simple facet application test

SearchFacetsTest::facetListProcedure() — Method in class SearchFacetsTest

Helper function for facets lists

FacetCloudTestClass in namespace VuFindTest\Recommend

FacetCloud recommendation module Test Class

FavoriteFacetsTestClass in namespace VuFindTest\Recommend

FavoriteFacets recommendation module Test Class

FormatsTestClass in namespace VuFindTest\RecordTab

Formats Test Class

$ SearchTabsHelperTest#filterConfigProperty in class SearchTabsHelperTest
FilterFieldConversionListenerTestClass in namespace VuFindTest\Search\Solr

Unit tests for FilterFieldConversionListener.

$ HierarchicalFacetHelperTest#facetListProperty in class HierarchicalFacetHelperTest

Test input data.

$ MultiIndexListenerTest#fieldsProperty in class MultiIndexListenerTest

Shard fields used for stripping tests.

$ Results#fakeExpectedTotalProperty in class Results

Fake expected total

$ Results#facetsProperty in class Results

Fake facet response

FileTestClass in namespace VuFindTest\Session

File Session Handler Test Class

$ ThemeInfoTest#fixturePathProperty in class ThemeInfoTest

Path to theme fixtures

$ ParentTemplateTest#fixturePathProperty in class ParentTemplateTest

Path to theme fixtures

FlashmessagesTestClass in namespace VuFindTest\View\Helper\Root

Flashmessages View Helper Test Class

RecordDataFormatterTest::findResult() — Method in class RecordDataFormatterTest

Find a result in the results array.

$ TemplatePathTest#fixturePathProperty in class TemplatePathTest

Path to theme fixtures

$ AbstractCssPreCompiler#fakePathProperty in class AbstractCssPreCompiler

Fake base path used for generating absolute paths in CSS.

$ ResourceContainer#faviconProperty in class ResourceContainer
Favicon
ThemeInfo::findContainingTheme() — Method in class ThemeInfo

Search the themes for a particular file. If it exists, return the first matching theme name; otherwise, return null.

ThemeInfo::findInThemes() — Method in class ThemeInfo

Search the themes for a file pattern. Returns all matching files.

ConcatTrait::filterItems() — Method in class ConcatTrait

Initialize class properties related to concatenation of resources.

FootScriptClass in namespace VuFindTheme\View\Helper

Footer script view helper (same as HeadScript but outputs to the bottom of )

HeadLink::forcePrependStylesheet() — Method in class HeadLink

Forcibly prepend a stylesheet removing it from any existing position

HeadScript::forcePrependFile() — Method in class HeadScript

Forcibly prepend a file removing it from any existing position

AbstractBase::formatResponse() — Method in class AbstractBase

Format a response array.

$ GetFacetData#facetHelperProperty in class GetFacetData

Hierarchical facet helper

GetItemStatuses::filterSuppressedLocations() — Method in class GetItemStatuses

Support method for getItemStatuses() -- filter suppressed locations from the array of item information for a particular bib record.

GetItemStatuses::formatCallNo() — Method in class GetItemStatuses

Create a delimited version of the call number to allow the Javascript code to handle the prefix appropriately.

GetSaveStatuses::formatListData() — Method in class GetSaveStatuses

Format list object into array.

$ GetSideFacets#facetHelperProperty in class GetSideFacets

Hierarchical facet helper

$ GetSideFacets#facetConfigProperty in class GetSideFacets

Main facet configuration

GetSideFacets::formatFacets() — Method in class GetSideFacets

Format facets according to their type

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

FacebookClass in namespace VuFind\Auth

Facebook authentication module.

FacebookFactoryClass in namespace VuFind\Auth

Factory for Facebook authentication module.

LDAP::findUsername() — Method in class LDAP

Find the specified username in the directory

$ MultiAuth#filtersProperty in class MultiAuth

Filter configuration for credentials

MultiAuth::filterCredentials() — Method in class MultiAuth

Load credentials into the object and apply internal filter settings to them.

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ Solr#filtersProperty in class Solr

Filters to apply to Solr search

$ SolrPrefix#facetFieldProperty in class SolrPrefix

Facet field

$ SolrPrefix#filtersProperty in class SolrPrefix

Filters to apply to Solr search

$ ImporterConfig#fieldsProperty in class ImporterConfig

Field data

$ Manager#factoryProperty in class Manager

Factory for creating storage adapters.

FigletClass in namespace VuFind\Captcha

Figlet CAPTCHA.

FigletFactoryClass in namespace VuFind\Captcha

Figlet CAPTCHA factory.

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

FacetsClass in namespace VuFind\ChannelProvider

Facet-driven channel provider.

$ Facets#fieldsProperty in class Facets

Facet fields to use (field name => description).

FacetsFactoryClass in namespace VuFind\ChannelProvider

Factory for Facets channel provider.

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

CacheDecorator::fromFile() — Method in class CacheDecorator

Read from a file and create an array

CacheDecorator::fromString() — Method in class CacheDecorator

Read from a string and create an array

$ Upgrade#fromProperty in class Upgrade

Version we're upgrading from

Upgrade::fileContainsMeaningfulLines() — Method in class Upgrade

Does the specified properties file contain any meaningful (non-empty/non-comment) lines?

$ Writer#filenameProperty in class Writer

Configuration file to write

$ YamlReader#filesProperty in class YamlReader

Cache of loaded files.

Oracle::free() — Method in class Oracle

Wrapper around oci_free_statement.

FacetListClass in namespace VuFind\ContentBlock

FacetList content block.

$ FacetList#facetCacheManagerProperty in class FacetList

Facet cache plugin manager

FacetListFactoryClass in namespace VuFind\ContentBlock

FacetList content block factory.

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

FactoryClass in namespace VuFind\Content

Factory for instantiating content loaders

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

AbstractBase::forceLogin() — Method in class AbstractBase

Redirect the user to the login screen.

AbstractBase::forwardTo() — Method in class AbstractBase

Convenience method to make invocation of forward() helper less verbose.

AbstractBase::formWasSubmitted() — Method in class AbstractBase

Check to see if a form was submitted from its post value Also validate the Captcha, if it's activated

AbstractBase::favorites() — Method in class AbstractBase

Favorites plugin

AbstractBase::flashMessenger() — Method in class AbstractBase

FlashMessenger plugin

AbstractBase::followup() — Method in class AbstractBase

Followup plugin

$ AbstractRecord#fallbackDefaultTabProperty in class AbstractRecord

Default tab to display (fallback used if no record driver configuration)

AbstractSearch::facetListAction() — Method in class AbstractSearch

Returns a list of all items associated with one facet for the lightbox

AjaxResponseTrait::formatContent() — Method in class AjaxResponseTrait

Format the content of the AJAX response based on the response type.

AuthorController::facetListAction() — Method in class AuthorController

Returns a list of all items associated with one facet for the lightbox

FeedbackControllerClass in namespace VuFind\Controller

Controller for configurable forms (feedback etc).

$ FeedbackController#formClassProperty in class FeedbackController

Feedback form class

FeedbackController::formAction() — Method in class FeedbackController

Handles rendering and submit of dynamic forms.

InstallController::fixbasicconfigAction() — Method in class InstallController

Display repair instructions for basic configuration problems.

InstallController::fixcacheAction() — Method in class InstallController

Display repair instructions for cache problems.

InstallController::fixdependenciesAction() — Method in class InstallController

Show how to fix dependency problems.

InstallController::fixdatabaseAction() — Method in class InstallController

Display repair instructions for database problems.

InstallController::fixilsAction() — Method in class InstallController

Display repair instructions for ILS problems.

InstallController::fixsolrAction() — Method in class InstallController

Display repair instructions for Solr problems.

InstallController::fixSecurityConfiguration() — Method in class InstallController

Support method for fixsecurityAction(). Returns true if the configuration was modified, false otherwise.

InstallController::fixsecurityAction() — Method in class InstallController

Display repair instructions for Security problems.

InstallController::fixsslcertsAction() — Method in class InstallController

Display repair instructions for SSL certificate problems.

MyResearchController::favoritesAction() — Method in class MyResearchController

Action for sending all of a user's saved favorites to the view

MyResearchController::finesAction() — Method in class MyResearchController

Send list of fines to view

DbUpgrade::fixCharsetAndCollationProblems() — Method in class DbUpgrade

Fix character set and collation problems based on the output of getCharsetAndCollationProblems().

FavoritesClass in namespace VuFind\Controller\Plugin

Action helper to perform favorites-related actions

FavoritesFactoryClass in namespace VuFind\Controller\Plugin

Factory for Favorites controller plugin.

FlashMessengerFactoryClass in namespace VuFind\Controller\Plugin

Factory for FlashMessenger controller plugin.

FollowupClass in namespace VuFind\Controller\Plugin

Action helper to deal with login followup; responsible for remembering URLs before login and then redirecting the user to the appropriate place afterwards.

FollowupFactoryClass in namespace VuFind\Controller\Plugin

Factory for Followup controller plugin.

Reserves::findReserves() — Method in class Reserves

Get reserve info from the catalog or Solr reserves index.

ResultScroller::fetchPreviousPage() — Method in class ResultScroller

Return a modified results array for the case where the user is on the cusp of the previous page of results

ResultScroller::fetchNextPage() — Method in class ResultScroller

Return a modified results array for the case where the user is on the cusp of the next page of results

ResultScroller::fetchPage() — Method in class ResultScroller

Fetch the given page of results from the given search object and return the IDs of the records in an array.

UpgradeController::fixconfigAction() — Method in class UpgradeController

Upgrade the configuration files.

UpgradeController::fixVuFindSourceInDatabase() — Method in class UpgradeController

Support method for fixdatabaseAction() -- clean up legacy 'VuFind' source values in the database.

UpgradeController::fixSearchChecksumsInDatabase() — Method in class UpgradeController

Support method for fixdatabaseAction() -- add checksums to search table rows.

UpgradeController::fixdatabaseAction() — Method in class UpgradeController

Upgrade the database.

UpgradeController::fixanonymoustagsAction() — Method in class UpgradeController

Prompt the user about fixing anonymous tags.

UpgradeController::fixduplicatetagsAction() — Method in class UpgradeController

Prompt the user about fixing duplicate tags.

UpgradeController::fixmetadataAction() — Method in class UpgradeController

Fix missing metadata in the resource table.

UpgradeController::fixshortlinks() — Method in class UpgradeController

Generate base62 encoding to migrate old shortlinks

CachingProxy::fetch() — Method in class CachingProxy

Fetch an image from either a URL or the cache (as appropriate).

CachingProxy::fetchCache() — Method in class CachingProxy

Load a response from cache (or return false if cache is missing).

Generator::fontPath() — Method in class Generator

Find font in the theme folder

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

Loader::fetchFromAPI() — Method in class Loader

Load bookcover from cache or remote provider and display if possible.

Loader::fetchFromContentType() — Method in class Loader

Load content type icon image from URL from theme images and display if possible.

FeedbackClass in namespace VuFind\Db\Row

Class Feedback

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ Search#folder_idProperty in class Search
$ User#firstnameProperty in class User
User::formatTagString() — Method in class User

Same as getTagString(), but operates on a list of tags.

FeedbackClass in namespace VuFind\Db\Table

Class Feedback

OaiResumption::findToken() — Method in class OaiResumption

Retrieve a row from the database based on primary key; return null if it is not found.

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

Record::findRecord() — Method in class Record

Find a record by id

Record::findRecords() — Method in class Record

Find records by ids

Resource::findResource() — Method in class Resource

Look up a row for the specified resource.

Resource::findResources() — Method in class Resource

Look up a rowset for a set of specified resources.

Resource::findMissingMetadata() — Method in class Resource

Get a set of records that do not have metadata stored in the resource table.

ResourceTags::formatTagOrder() — Method in class ResourceTags

Given an array for sorting database results, make sure the tag field is sorted in a case-insensitive fashion.

Tags::fixDuplicateTag() — Method in class Tags

Support method for fixDuplicateTags()

Tags::fixDuplicateTags() — Method in class Tags

Repair duplicate tags in the database (if any).

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

FileAccessClass in namespace VuFind\Exception

File Access Exception

ForbiddenClass in namespace VuFind\Exception

"Forbidden Access" Exception

FormatUnavailableClass in namespace VuFind\Exception

"Format Unavailable" Exception

FavoritesServiceClass in namespace VuFind\Favorites

Favorites service

FavoritesServiceFactoryClass in namespace VuFind\Favorites

Favorites service

FeedClass in namespace VuFind\Feed\Writer\Extension\OpenSearch

Laminas\Feed\Feed extension for Open Search

FeedClass in namespace VuFind\Feed\Writer\Extension\OpenSearch\Renderer

Laminas\Feed\Renderer\Feed extension for Open Search

FormClass in namespace VuFind\Form

Configurable form.

$ Form#formElementConfigProperty in class Form

Form element configuration

$ Form#formConfigProperty in class Form

Form configuration

Form::formatEmailMessage() — Method in class Form

Format email message.

FormFactoryClass in namespace VuFind\Form

Factory for configurable forms.

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

Json::formatNode() — Method in class Json

Get Solr Children for JSON

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

Xml::formatNode() — Method in class Xml

Get Solr Children for JSON

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ Solr#formatterManagerProperty in class Solr

Formatter manager

$ Solr#filtersProperty in class Solr

Filter queries

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

ExtendedIniNormalizer::formatAsString() — Method in class ExtendedIniNormalizer

Normalize a TextDomain or array to a string that can be written to file.

ExtendedIniNormalizer::filenameMatchesFilter() — Method in class ExtendedIniNormalizer

Check if the given filename matches the filter pattern

LocaleDetectorCookieStrategy::found() — Method in class LocaleDetectorCookieStrategy

Event handler for the 'found' event

$ LocaleSettings#fallbackLocalesProperty in class LocaleSettings

Prioritized array of locales to use when strings are missing from the primary language file.

$ ExtendedIni#fallbackLocalesProperty in class ExtendedIni

Fallback locales to use for language strings missing from selected file.

$ Connection#failingProperty in class Connection

Is the current ILS driver failing?

Connection::failOverToNoILS() — Method in class Connection

If configured, fail over to the NoILS driver and return true; otherwise, return false.

AbstractAPI::failureCodeIsAllowed() — Method in class AbstractAPI

Does $code match the setting for allowed failure codes?

Aleph::findReserves() — Method in class Aleph

Find Reserves

Alma::findReserves() — Method in class Alma

Get reserves by course

Amicus::findReserves() — Method in class Amicus

Find Reserves

$ Demo#failureProbabilitiesProperty in class Demo

Failure probability settings

Demo::findReserves() — Method in class Demo

Find Reserves

Evergreen::findReserves() — Method in class Evergreen

Find Reserves

Evergreen::formatDate() — Method in class Evergreen

Format date

FolioClass in namespace VuFind\ILS\Driver

FOLIO REST API driver

Folio::fetchUserWithCql() — Method in class Folio

Given a CQL query, fetch a single user; if we get an unexpected count, treat that as an unsuccessful login by returning null.

Folio::findReserves() — Method in class Folio

Find Reserves

FolioFactoryClass in namespace VuFind\ILS\Driver

Factory for Folio ILS driver.

KohaILSDI::findReserves() — Method in class KohaILSDI

Find Reserves

$ KohaRest#feeTypeMappingsProperty in class KohaRest

Mappings from fee (account line) types

KohaRest::findReserves() — Method in class KohaRest

Find Reserves

KohaRest::formatMoney() — Method in class KohaRest

Helper function for formatting currency

MultiBackend::findReserves() — Method in class MultiBackend

Find Reserves

NoILS::findReserves() — Method in class NoILS

Find Reserves

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

Polaris::formatJSONTime() — Method in class Polaris

Return human-readable date from text like Date(1360051200000-0800)

Polaris::findReserves() — Method in class Polaris

Find Reserves

Sample::findReserves() — Method in class Sample

Find Reserves

Sierra::findReserves() — Method in class Sierra

Find Reserves

SierraRest::findReserves() — Method in class SierraRest

Find Reserves

SierraRest::formatCacheKey() — Method in class SierraRest

Add instance-specific context to a cache key suffix to ensure that multiple drivers don't accidentally share values in the cache.

SierraRest::formatErrorMessage() — Method in class SierraRest

Format an error message received from Sierra

SierraRest::formatBibId() — Method in class SierraRest

If the system is configured to use full prefixed bib IDs, add the prefix and checksum.

Unicorn::findReserves() — Method in class Unicorn

Find Reserves

Unicorn::formatDateTime() — Method in class Unicorn

Format the given unix time stamp to a human readable format. The format is configurable in Unicorn.ini

Virtua::findReserves() — Method in class Virtua

Find Reserves

Virtua::fakeLogin() — Method in class Virtua

Fake a virtua login on the patron's behalf.

Voyager::findReserves() — Method in class Voyager

Find Reserves

$ XCNCIP2#fromAgencyProperty in class XCNCIP2

From agency id

XCNCIP2::findReserves() — Method in class XCNCIP2

Find Reserves

Holds::formatHoldings() — Method in class Holds

Support method to rearrange the holdings array for displaying convenience.

FactoryClass in namespace VuFind\Mailer

Factory for instantiating Mailer objects

$ Mailer#fromAddressOverrideProperty in class Mailer

"From" address override

ScopeRepository::finalizeScopes() — Method in class ScopeRepository

Given a client, grant type and optional user identifier validate the set of scopes requested are valid and optionally append additional scopes or remove requested scopes.

Loader::fetchQRCode() — Method in class Loader

Generate a QR code image

$ AuthorityRecommend#filtersProperty in class AuthorityRecommend

Configured filters for authority searches

AuthorityRecommend::fuzzyCompare() — Method in class AuthorityRecommend

Return true if $a and $b are similar enough to represent the same heading.

$ DPLATerms#formatMapProperty in class DPLATerms

Map of Solr field names to equivalent API parameters

$ ExpandFacets#facetsProperty in class ExpandFacets

Facets to display

FacetCloudClass in namespace VuFind\Recommend

FacetCloud Recommendations Module

FavoriteFacetsClass in namespace VuFind\Recommend

FavoriteFacets Recommendations Module

FavoriteFacetsFactoryClass in namespace VuFind\Recommend

FavoriteFacets recommendation module factory.

MapSelection::fetchDataFromSearchService() — Method in class MapSelection

Fetch details from search service

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ RandomRecommend#filtersProperty in class RandomRecommend
Filters
$ SideFacets#fullDateFacetsProperty in class SideFacets

Day/month/year date facet configuration

$ TopFacets#facetsProperty in class TopFacets

Facet configuration

$ VisualFacets#facetsProperty in class VisualFacets

Facet configuration

$ AbstractBase#fieldsProperty in class AbstractBase

Raw data

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ SolrDefault#forbiddenSnippetFieldsProperty in class SolrDefault

These Solr fields should NEVER be used for snippets. (We exclude author and title because they are already covered by displayed fields; we exclude spelling because it contains lots of fields jammed together and may cause glitchy output; we exclude ID because random numbers are not helpful).

FormatsClass in namespace VuFind\RecordTab

Digital Content Formats

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

AbstractFallbackLoader::fetchSingleRecord() — Method in class AbstractFallbackLoader

Fetch a single record (null if not found).

FallbackLoaderInterfaceClass in namespace VuFind\Record\FallbackLoader

Record fallback loader interface

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

Solr::fetchSingleRecord() — Method in class Solr

Fetch a single record (null if not found).

Summon::fetchSingleRecord() — Method in class Summon

Fetch a single record (null if not found).

$ Loader#fallbackLoaderProperty in class Loader

Fallback record loader

$ Bookplate#fieldsProperty in class Bookplate

Data fields (usually Solr)

$ Bookplate#fullUrlTemplateProperty in class Bookplate

URL template for full bookplate

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ CsvReader#filesProperty in class CsvReader

Files to load

Connection::fetchLinks() — Method in class Connection

Fetch Links

Alma::fetchLinks() — Method in class Alma

Fetch Links

Demo::fetchLinks() — Method in class Demo

Fetch Links

DriverInterface::fetchLinks() — Method in class DriverInterface

Fetch Links

Generic::fetchLinks() — Method in class Generic

Fetch Links

Jop::fetchLinks() — Method in class Jop

Fetch Links

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

Redi::fetchLinks() — Method in class Redi

Fetch Links

Sfx::fetchLinks() — Method in class Sfx

Fetch Links

Threesixtylink::fetchLinks() — Method in class Threesixtylink

Fetch Links

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

AbstractBase::filterPhoneNumber() — Method in class AbstractBase

Filter bad characters from a phone number

Clickatell::formatMessage() — Method in class Clickatell

Format message for texting.

FactoryClass in namespace VuFind\SMS

Factory for instantiating SMS objects

$ BackendRegistry#factoriesProperty in class BackendRegistry

Default plugin factories.

FacetCacheClass in namespace VuFind\Search\Base

Solr FacetCache Factory.

FacetCacheFactoryClass in namespace VuFind\Search\Base

Abstract FacetCache Factory.

HierarchicalFacetHelperInterface::flattenFacetHierarchy() — Method in class HierarchicalFacetHelperInterface

Flatten a hierarchical facet list to a simple array

HierarchicalFacetHelperInterface::formatDisplayText() — Method in class HierarchicalFacetHelperInterface

Format a facet display text for displaying

$ Options#facetSortOptionsProperty in class Options

Available sort options for facets

$ Options#facetsIniProperty in class Options

Configuration file to read facet settings from

$ Options#firstlastNavigationProperty in class Options

Is the first/last navigation scroller enabled?

$ Params#facetConfigProperty in class Params

Main facet configuration

$ Params#filterListProperty in class Params

Applied filters

$ Params#facetAliasesProperty in class Params

Map of facet field aliases.

Params::formatFilterListEntry() — Method in class Params

Format a single filter for use in getFilterList().

Params::formatFilterArrayAsQueryParams() — Method in class Params

Format a raw filter array as a query parameter array.

Params::formatYearForDateRange() — Method in class Params

Support method for initDateFilters() -- normalize a year for use in a year-based date range.

Params::formatDateForFullDateRange() — Method in class Params

Support method for initFullDateFilters() -- normalize a date for use in a year/month/day date range.

Params::formatValueForNumericRange() — Method in class Params

Support method for initNumericRangeFilters() -- normalize a year for use in a date range.

Options::filterAndReorderProperty() — Method in class Options

Apply user settings. All legal values have already been loaded from the API at the time this method is called, so we just need to check if the user-supplied values are valid, and if so, filter/reorder accordingly.

$ Params#fullFacetSettingsProperty in class Params

Facet settings

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ AbstractSolrBackendFactory#facetConfigProperty in class AbstractSolrBackendFactory

Facet configuration file identifier.

$ BlenderBackendFactory#facetConfigProperty in class BlenderBackendFactory

Facet configuration file identifier.

UrlQueryHelperFactory::fromParams() — Method in class UrlQueryHelperFactory

Construct the UrlQueryHelper

$ Results#facetsProperty in class Results

Facet list

Memory::forgetSearch() — Method in class Memory

Clear the last accessed search URL in the session.

$ Minified#fProperty in class Minified
Filters
$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

FacetLimitTraitClass in namespace VuFind\Search\Params

Trait to add facet limiting settings to a Params object.

$ FacetLimitTrait#facetLimitProperty in class FacetLimitTrait

Default facet result limit

$ FacetLimitTrait#facetLimitByFieldProperty in class FacetLimitTrait

Per-field facet result limit

FacetRestrictionsTraitClass in namespace VuFind\Search\Params

Trait to add facet limiting settings to a Params object.

$ FacetRestrictionsTrait#facetPrefixByFieldProperty in class FacetRestrictionsTrait

Per-field facet prefix

$ FacetRestrictionsTrait#facetMatchesByFieldProperty in class FacetRestrictionsTrait

Per-field facet matches

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ Params#facetValueMappingsProperty in class Params

Mappings of specific Primo facet values (spelling errors and other special cases present at least in CDI)

Params::fixPrimoFacetValue() — Method in class Params

Normalize a Primo facet value.

QueryAdapter::fromRequest() — Method in class QueryAdapter

Convert user request parameters into a query (currently for advanced searches only).

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

FacetCacheClass in namespace VuFind\Search\Search2

Search2 FacetCache.

$ SearchTabsHelper#filterConfigProperty in class SearchTabsHelper

Tab filter configuration

SearchTabsHelper::filtersMatch() — Method in class SearchTabsHelper

Check if given hidden filters match with the hidden filters from configuration

$ CustomFilterListener#filterParamProperty in class CustomFilterListener

Name of parameter used to store filters

DeduplicationListener::fetchLocalRecords() — Method in class DeduplicationListener

Fetch local records for all the found dedup records

FacetCacheClass in namespace VuFind\Search\Solr

Solr FacetCache.

FacetCacheFactoryClass in namespace VuFind\Search\Solr

Solr FacetCache Factory.

FilterFieldConversionListenerClass in namespace VuFind\Search\Solr

Listener to convert one field to another in filters (for legacy purposes).

HierarchicalFacetHelper::flattenFacetHierarchy() — Method in class HierarchicalFacetHelper

Flatten a hierarchical facet list to a simple array

HierarchicalFacetHelper::formatDisplayText() — Method in class HierarchicalFacetHelper

Format a facet display text for displaying

$ HierarchicalFacetListener#facetConfigProperty in class HierarchicalFacetListener

Facet configuration.

$ HierarchicalFacetListener#facetHelperProperty in class HierarchicalFacetListener

Facet helper.

HierarchicalFacetListener::formatFacetField() — Method in class HierarchicalFacetListener

Format a facet field according to the settings

$ InjectConditionalFilterListener#filterListProperty in class InjectConditionalFilterListener

Filters to apply.

$ InjectConditionalFilterListener#filtersProperty in class InjectConditionalFilterListener

Filters from configuration.

$ InjectHighlightingListener#fieldListProperty in class InjectHighlightingListener

Fields to highlight when active.

$ Options#facetSortOptionsProperty in class Options

Available sort options for facets

$ Params#facetContainsProperty in class Params

Search with facet.contains cf. https://lucene.apache.org/solr/guide/7_3/faceting.html

$ Params#facetContainsIgnoreCaseProperty in class Params

Ignore Case when using facet.contains cf. https://lucene.apache.org/solr/guide/7_3/faceting.html

$ Params#facetOffsetProperty in class Params

Offset for facet results

$ Params#facetPrefixProperty in class Params

Prefix for facet searching

$ Params#facetSortProperty in class Params

Sorting order for facet search results

$ Params#facetHelperProperty in class Params

Hierarchical Facet Helper

Params::formatFilterListEntry() — Method in class Params

Format a single filter for use in getFilterList().

Results::fixBadQuery() — Method in class Results

Try to fix a query that caused a parser error.

Results::fixBadQueryGroup() — Method in class Results

Support method for fixBadQuery().

SpellingProcessor::formatAndFilterSuggestions() — Method in class SpellingProcessor

Support method for getSuggestions()

FacetCacheClass in namespace VuFind\Search\Summon

Summon FacetCache.

$ Params#fullFacetSettingsProperty in class Params

Settings for all the facets

Params::formatFilterListEntry() — Method in class Params

Format a single filter for use in getFilterList().

Results::formatFacetData() — Method in class Results

Support method for getFacetList() -- format a single facet field.

$ Params#fuzzyProperty in class Params

Is this a fuzzy search?

Results::formatFuzzyQuery() — Method in class Results

Process a fuzzy tag query.

UrlQueryHelper::filtered() — Method in class UrlQueryHelper

Support method for asHiddenFields -- are the provided field and value excluded by the provided filter?

$ CurrencyFormatter#formatterProperty in class CurrencyFormatter

Number formatter.

FileClass in namespace VuFind\Session

File-based session handler

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ Generator#frequencyProperty in class Generator

Frequency of URL updates (always, daily, weekly, monthly, yearly, never)

$ Generator#fileLocationProperty in class Generator

Output file path

$ Generator#fileStartProperty in class Generator

Base path to sitemap files, including base filename

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

$ Index#filtersProperty in class Index

Search filters

$ Sitemap#frequencyProperty in class Sitemap

Frequency of URL updates (always, daily, weekly, monthly, yearly, never)

$ PluginManager#factoriesProperty in class PluginManager

Default plugin factories.

FlashmessagesClass in namespace VuFind\View\Helper\Bootstrap3

Flash message view helper

Citation::fixAbbreviatedNameLetters() — Method in class Citation

Fix bad punctuation on abbreviated name letters.

Citation::formatPrimaryMLAAuthor() — Method in class Citation

Format an author name for inclusion as the first name in an MLA citation.

Citation::formatSecondaryMLAAuthor() — Method in class Citation

Format an author name for inclusion in an MLA citation (after the primary name, which gets formatted differently).

FeedbackClass in namespace VuFind\View\Helper\Root

This is a helper that lets the layout know whether or not to include the feedback tab

FeedbackFactoryClass in namespace VuFind\View\Helper\Root

Feedback helper factory.

FlashmessagesClass in namespace VuFind\View\Helper\Root

Flash message view helper

$ Flashmessages#fmProperty in class Flashmessages

Flash messenger controller helper

FlashmessagesFactoryClass in namespace VuFind\View\Helper\Root

Flashmessages helper factory.

Processor::findXslt() — Method in class Processor

Locate an XSLT file and return its full path.

G

SearchApiController::getApiSpecFragment() — Method in class SearchApiController

Get API specification JSON fragment for services provided by the controller

SearchApiController::getItemFieldList() — Method in class SearchApiController

Get field list based on the request

Module::getConfig() — Method in class Module

Get module configuration

Module::getAutoloaderConfig() — Method in class Module

Get autoloader configuration

Module::getConfig() — Method in class Module

Get module configuration

Module::getAutoloaderConfig() — Method in class Module

Get autoloader configuration

Module::getConfig() — Method in class Module

Get module configuration

Module::getAutoloaderConfig() — Method in class Module

Get autoloader configuration

MultiBackendTest::getDriver() — Method in class MultiBackendTest

Method to get a fresh MultiBackend Driver.

MultiBackendTest::getMockInstConfigs() — Method in class MultiBackendTest
MultiBackendTest::getMockInstSources() — Method in class MultiBackendTest
MultiBackendTest::getMockSolrIdResolver() — Method in class MultiBackendTest
MultiBackendTest::getPluginManager() — Method in class MultiBackendTest

Method to get a fresh Plugin Manager.

MultiBackendTest::getMockILSAuthenticator() — Method in class MultiBackendTest

Get a mock ILS authenticator

MultiBackendTest::getMockSM() — Method in class MultiBackendTest

This function returns a mock service manager with the given parameters For examples of what is to be passed, see: http://www.phpunit.de/manual/3.0/en/mock-objects.html

GetACSuggestionsClass in namespace KnihovnyCz\AjaxHandler

"Get Autocomplete Suggestions" AJAX handler

GetACSuggestionsFactoryClass in namespace KnihovnyCz\AjaxHandler

Factory for GetACSuggestions AJAX handler.

GetCitationsClass in namespace KnihovnyCz\AjaxHandler

Class GetCitations

GetCitationsFactoryClass in namespace KnihovnyCz\AjaxHandler

Class GetCitationFactory

GetHoldingClass in namespace KnihovnyCz\AjaxHandler

Class Get Holding

GetHoldingFactoryClass in namespace KnihovnyCz\AjaxHandler

Class Get Holding Factory

GetLibrariesACSuggestionsClass in namespace KnihovnyCz\AjaxHandler

"Get Autocomplete Suggestions" AJAX handler

GetLibrariesACSuggestionsFactoryClass in namespace KnihovnyCz\AjaxHandler

Factory for GetLibrariesACSuggestions AJAX handler.

GetObalkyKnihCoverWithoutSolrClass in namespace KnihovnyCz\AjaxHandler

Class GetObalkyKnihCoverWithoutSolr

GetObalkyKnihCoverWithoutSolrFactoryClass in namespace KnihovnyCz\AjaxHandler

Class GetObalkyKnihCoverWithoutSolrFactory

GetUserFinesFactoryClass in namespace KnihovnyCz\AjaxHandler

Factory for GetUserFines AJAX handler.

GetUserProfileClass in namespace KnihovnyCz\AjaxHandler

"Get User Profile" AJAX handler

GetZiskejEddFeeClass in namespace KnihovnyCz\AjaxHandler

Class Get Ziskej Edd Fee

GetZiskejEddFeeFactoryClass in namespace KnihovnyCz\AjaxHandler

Class Get Ziskej Edd Fee Factory

Sfx::getSfxQuery() — Method in class Sfx

Extract SFX query from parameters.

Sfx::getSfxUrl() — Method in class Sfx

Call SFX server and return links to fulltext.

Shibboleth::getUserCardTable() — Method in class Shibboleth

Get access to the user table.

Shibboleth::getUserCardByEppnWithoutEpui() — Method in class Shibboleth

Return library card by eduPersonPrincipalName without eduPersonUniqueId.

SolrAuthorityEnricher::getSuggestions() — Method in class SolrAuthorityEnricher

Get suggestions

SolrPrefix::getSuggestions() — Method in class SolrPrefix

Get suggestions

SolrPrefixHandler::getSuggestions() — Method in class SolrPrefixHandler

Get suggestions

SolrPrefixSorted::getSuggestions() — Method in class SolrPrefixSorted

This method returns an array of strings matching the user's query for display in the autocomplete box.

Suggester::getSuggestions() — Method in class Suggester

This returns an array of suggestions based on current request parameters.

Suggester::getTypes() — Method in class Suggester

Return search types to use for suggestions

Suggester::getSuggestionsByType() — Method in class Suggester

This returns an array of suggestions based on current request parameters.

AbstractDbAwaredRecordIds::getList() — Method in class AbstractDbAwaredRecordIds

Get list

AbstractDbAwaredRecordIds::getItems() — Method in class AbstractDbAwaredRecordIds

Get inspiration list items

AbstractDbAwaredRecordIds::getSlug() — Method in class AbstractDbAwaredRecordIds

Get slug identifier to search for

AbstractDbAwaredRecordIds::getContext() — Method in class AbstractDbAwaredRecordIds

Return context variables used for rendering the block's template.

AbstractDbAwaredRecordIds::getIds() — Method in class AbstractDbAwaredRecordIds

Takes and returns record ids from result set

DocumentTypes::getDocumentTypes() — Method in class DocumentTypes

Get values for content block

DocumentTypes::getContext() — Method in class DocumentTypes

Return context variables used for rendering the block's template.

TemplateBased::getContextForMd() — Method in class TemplateBased

Return context array for markdown

TemplateBased::getCacheKey() — Method in class TemplateBased

Method to ensure uniform cache keys for cached VuFind objects.

TemplateBasedForLoggedIn::getContext() — Method in class TemplateBasedForLoggedIn

Return context variables used for rendering the block's template.

TemplateBasedForUnloggedIn::getContext() — Method in class TemplateBasedForUnloggedIn

Return context variables used for rendering the block's template.

UserList::getIds() — Method in class UserList

Takes and returns record ids from result set

UserList::getSlug() — Method in class UserList

Get slug identifier to search for

InvolvedLibrariesService::getInvolvedLibraries() — Method in class InvolvedLibrariesService

Get libraries involved in project Knihovny.cz

ObalkyKnihService::getFromService() — Method in class ObalkyKnihService

Get data from service

ObalkyKnihService::getAuthorityFromService() — Method in class ObalkyKnihService

Get obalkyknih metadata for authority from external service

ObalkyKnihService::getAliveUrl() — Method in class ObalkyKnihService

Check base URLs and return the first available

PageLocator::getTemplateOptionsFromPattern() — Method in class PageLocator

Try to find a template using 1) Current language 2) Default language 3) No language

PageLocator::getCacheKey() — Method in class PageLocator

Method to ensure uniform cache keys for cached VuFind objects.

AbstractBase::getUser() — Method in class AbstractBase

Get the user object if logged in, false otherwise.

CartController::getCartActionFromRequest() — Method in class CartController

Figure out an action from the request.

CatalogLoginTrait::getCardId() — Method in class CatalogLoginTrait

Return card id to use

ContentController::getViewForMd() — Method in class ContentController

Get ViewModel for markdown based page

ContentController::getCacheKey() — Method in class ContentController

Method to ensure uniform cache keys for cached VuFind objects.

InspirationController::getListData() — Method in class InspirationController

Get inspiration list data

MyResearchController::getAccountContainer() — Method in class MyResearchController

Return a session container with user account.

ResultScroller::getScrollData() — Method in class ResultScroller

Get the previous/next record in the last search result set relative to the current one, also return the position of the current record in the result set.

ResultScroller::getLinkToResults() — Method in class ResultScroller

Get link to page with results

SearchController::getSearchResultsView() — Method in class SearchController

Perform a search and send results to a results view

User::getCardByCatName() — Method in class User

Get UserCard by card name

User::getCardByEppn() — Method in class User

Get library card using EduPersonPrincipalName

User::getCardByEppnDomain() — Method in class User

Get UserCard by eppn domain

User::getLibraryPrefixes() — Method in class User

Get library prefixes from connected library cards

User::getLibraryCardsWithILS() — Method in class User

Get all library cards associated with the user with enabled ILS.

User::getHashedId() — Method in class User

Returns salted sha1 hashed id for purposes of google analytics

User::getConnectedInstitutionsForGTM() — Method in class User

Returns string with connected institutions for purposes of Google Analytics Institutions are separated by commas For no institutions empty string is returned

User::getUserSettings() — Method in class User

Return user settings

UserCard::getEppnDomain() — Method in class UserCard

Get EduPersonPrincipalName scope

UserList::getSlug() — Method in class UserList

Create slug identifier

UserSettings::getSavedInstitutions() — Method in class UserSettings

Get library prefixes from connected library cards

Config::getConfigByFile() — Method in class Config

Get config by file

Config::getDataByConfigFile() — Method in class Config

Get configuration data from database

InstConfigs::getConfig() — Method in class InstConfigs

Retrieves config specified by a source

InstSources::getSource() — Method in class InstSources

Get information about instance

Resource::getFavorites() — Method in class Resource

Get a set of records from the requested favorite list.

User::getByEduPersonUniqueId() — Method in class User

Retrieve a user object from the database based on eduPersonUniqueId.

User::getDbConnection() — Method in class User

Returns database connection.

UserCard::getByEduPersonUniqueId() — Method in class UserCard

Retrieve a user card object from the database based on eduPersonUniqueId or create new one.

UserCard::getByEduPersonPrincipalName() — Method in class UserCard

Retrieve a user card object from the database based on eduPersonUniqueId or create new one.

UserList::getInspirationLists() — Method in class UserList

Get public lists usable as inspiration lists

UserSettings::getOrCreateByUserId() — Method in class UserSettings

Retrieve a user setting object from the database based on user id.

Parser::getBoundingBoxForDisplay() — Method in class Parser

Return user friendly representation of bounding box

Parser::getLatitudeDisplayText() — Method in class Parser

Return user friendly representation of latitude

Parser::getLongitudeDisplayText() — Method in class Parser

Return user friendly representation of longitude

Connection::getCapabilityParams() — Method in class Connection

Get capability parameters to check for each connected library card

Aleph::getConfig() — Method in class Aleph

Public Function which retrieves historic loan, renew, hold and cancel settings from the driver ini file.

Aleph::getHolding() — Method in class Aleph

Get Holding

Aleph::getMyTransactions() — Method in class Aleph

Get Patron Transactions

Aleph::getMyHolds() — Method in class Aleph

Get Patron Holds

Aleph::getMyProfileDLF() — Method in class Aleph

Get profile information using DLF service.

Aleph::getHoldOrderInQueue() — Method in class Aleph

Get hold order in queue

Aleph::getHoldingInfoForItem() — Method in class Aleph

Support method for placeHold -- get holding info for an item.

Aleph::getMyShortLoans() — Method in class Aleph

Return short loan requests for patron

Aleph::getMyShortLoanLinks() — Method in class Aleph

Return short loan requests for patron

Aleph::getCancelShortLoanDetails() — Method in class Aleph

Get details for canceling short loan request

Aleph::getMyPaymentLink() — Method in class Aleph

Return link to pay all fines

Aleph::getMyProlongRegistrationLink() — Method in class Aleph

Get link for prolonging of registration

KohaRest1905::getStatus() — Method in class KohaRest1905

Get Status

KohaRest1905::getStatuses() — Method in class KohaRest1905

Get Statuses

KohaRest1905::getHolding() — Method in class KohaRest1905

Get Holding

KohaRest1905::getPurchaseHistory() — Method in class KohaRest1905

Get Purchase History

KohaRest1905::getRequestBlocks() — Method in class KohaRest1905

Check whether the patron is blocked from placing requests (holds/ILL/SRR).

KohaRest1905::getAccountBlocks() — Method in class KohaRest1905

Check whether the patron has any blocks on their account.

KohaRest1905::getRenewDetails() — Method in class KohaRest1905

Get Renew Details

KohaRest1905::getMyProfile() — Method in class KohaRest1905

Get Patron Profile

KohaRest1905::getCheckouts() — Method in class KohaRest1905

Get patron checkouts

KohaRest1905::getMyTransactions() — Method in class KohaRest1905

Get Patron Transactions

KohaRest1905::getMyTransactionHistory() — Method in class KohaRest1905

Get Patron Loan History

KohaRest1905::getCheckoutRenewability() — Method in class KohaRest1905

Checks if item is renewable

KohaRest1905::getMyHolds() — Method in class KohaRest1905

Get Patron Holds

KohaRest1905::getPickUpLocations() — Method in class KohaRest1905

Get Pick Up Locations

KohaRest1905::getDefaultPickUpLocation() — Method in class KohaRest1905

Get Default Pick Up Location

KohaRest1905::getCancelHoldDetails() — Method in class KohaRest1905

Get Cancel Hold Details

KohaRest1905::getMyFines() — Method in class KohaRest1905

Get Patron Fines

KohaRest1905::getItemStatusesForBiblio() — Method in class KohaRest1905

Get Item Statuses

KohaRest1905::getStatusByItemId() — Method in class KohaRest1905

Get Status By Item ID

KohaRest1905::getItem() — Method in class KohaRest1905

Fetch an item record from Koha

KohaRest1905::getBiblio() — Method in class KohaRest1905

Fetch a bib record from Koha

KohaRest1905::getLibrary() — Method in class KohaRest1905

Get library by id

KohaRest1905::getLibraries() — Method in class KohaRest1905

Get all libraries

KohaRest1905::getLibraryName() — Method in class KohaRest1905

Get library name from code

KohaRest1905::getItemLocationName() — Method in class KohaRest1905

Return a location for a Koha item

KohaRest1905::getConfig() — Method in class KohaRest1905

Get service configuration

KohaRest1905::getPatron() — Method in class KohaRest1905

Get patron data

KohaRest1905::getData() — Method in class KohaRest1905

Get data from cache or from API

KohaRest1905::getCacheKey() — Method in class KohaRest1905

Method to ensure uniform cache keys for cached VuFind objects.

KohaRest1905::getOAuth2Token() — Method in class KohaRest1905

Get a new or cached OAuth2 token (type + token)

MultiBackend::getDriverConfig() — Method in class MultiBackend

Get configuration for the ILS driver. We load the settings from DB.

MultiBackend::getMyTransactions() — Method in class MultiBackend

Get Patron Transactions

MultiBackend::getMyShortLoans() — Method in class MultiBackend

Return short loan requests for patron

MultiBackend::getMyTransactionHistory() — Method in class MultiBackend

Get Patron Transaction History

MultiBackend::getMyHolds() — Method in class MultiBackend

Get Patron Holds

MultiBackend::getMyProfile() — Method in class MultiBackend

Get Patron Profile

MultiBackend::getStatusByItemIdOrBibId() — Method in class MultiBackend

Get Status By Item ID or Bibliographic ID

MultiBackend::getStatusByItemId() — Method in class MultiBackend

Get Status By Item ID

MultiBackend::getDriverName() — Method in class MultiBackend

Get short driver name

MultiBackend::getIlsType() — Method in class MultiBackend

Get ILS type - only suitable for XCNCIP2 driver

XCNCIP2::getConfig() — Method in class XCNCIP2

Public Function which specifies renew, hold and cancel settings.

XCNCIP2::getHoldType() — Method in class XCNCIP2

Get Hold Type

XCNCIP2::getHolding() — Method in class XCNCIP2

Get Holding

XCNCIP2::getMyTransactionHistory() — Method in class XCNCIP2

Get Patron Loan History

XCNCIP2::getNCIPMessageStart() — Method in class XCNCIP2

Helper method for creating XML header and main element start

XCNCIP2::getStatusByItemId() — Method in class XCNCIP2

Get Status By Item ID

XCNCIP2::getMyProfile() — Method in class XCNCIP2

Get Patron Profile

XCNCIP2::getDefaultPickUpLocation() — Method in class XCNCIP2

Get Default Pick Up Location

Holdings::getAvailabilityByStatus() — Method in class Holdings

Get availability status

MultiConnection::getMyTransactions() — Method in class MultiConnection

Get Patron Transactions

MultiConnection::getMyHolds() — Method in class MultiConnection

Get Patron Holds

MultiConnection::getMyFines() — Method in class MultiConnection

Get Patron Fines

MultiConnection::getMyProfile() — Method in class MultiConnection

Get Patron Profile

MultiConnection::getAuthManager() — Method in class MultiConnection

Get auth manager

InvolvedLibrariesBuilder::generate() — Method in class InvolvedLibrariesBuilder

Generate node tree

InvolvedLibrariesParser::getBlock() — Method in class InvolvedLibrariesParser

Get main node

InvolvedLibrariesRenderer::getXmlTagName() — Method in class InvolvedLibrariesRenderer

Get tag for XML output

InvolvedLibrariesRenderer::getXmlAttributes() — Method in class InvolvedLibrariesRenderer

Get attributes for XML output

Module::getConfig() — Method in class Module

Get module configuration

Module::getAutoloaderConfig() — Method in class Module

Get autoloader configuration

$ MapSelection#geoFieldStrProperty in class MapSelection

The geo solr field where coordinates are stored

MapSelection::getMapResultCoordinates() — Method in class MapSelection

Process search result record coordinate values for Leaflet mapping platform.

MapSelection::getMapScaleField() — Method in class MapSelection

Return Solr field to use for search by map scale

MapSelection::getSelectedMapScale() — Method in class MapSelection

Return selected map scale

MapSelection::getRangeFilter() — Method in class MapSelection

Parse range query and return filter to apply

RecommendOtherPortals::getLinks() — Method in class RecommendOtherPortals

Get link to main portal

SideFacetsDeferred::getInstitutionField() — Method in class SideFacetsDeferred

Get Solr institution filed

SideFacetsDeferred::getSelectedInstitutionFilter() — Method in class SideFacetsDeferred

Get selected institution filter

SideFacetsDeferred::getMyFilter() — Method in class SideFacetsDeferred

Get filter with my institutions

SideFacetsDeferred::getMyInstitutions() — Method in class SideFacetsDeferred

Get values for my institutions filter

EDS::getAccessUrl() — Method in class EDS

Get access url

EDS::getFullTextLinks() — Method in class EDS

Get fulltext links

EDS::getFTCustomLinks() — Method in class EDS

Get the full text custom links of the record.

EDS::getCacheKey() — Method in class EDS

Method to ensure uniform cache keys for cached VuFind objects.

BibframeTrait::getBibframeRdfXml() — Method in class BibframeTrait

Get an XML RDF representation of the data in this record using BIBFRAME and MADS ontologies

$ BuyLinksTrait#googlebooksServiceProperty in class BuyLinksTrait

Service for getting link Google Books

BuyLinksTrait::getBuyLinksConfiguration() — Method in class BuyLinksTrait

Get buy links configuration

BuyLinksTrait::getBuyLinks() — Method in class BuyLinksTrait

Get buy links

BuyLinksTrait::getAntikvariatyLink() — Method in class BuyLinksTrait

Get link to muj-antikvariat.cz

BuyLinksTrait::getZboziLink() — Method in class BuyLinksTrait

Get link to Zboží.cz

BuyLinksTrait::getGoogleBooksLink() — Method in class BuyLinksTrait

Get link to Google Books

CitaceProTrait::getCitationFormats() — Method in class CitaceProTrait

Get citation formats

CitaceProTrait::getDefaultCitationStyle() — Method in class CitaceProTrait

Get default citation style identifier

CitaceProTrait::getCitation() — Method in class CitaceProTrait

Get citation HTML snippet

CitaceProTrait::getCitationLink() — Method in class CitaceProTrait

Get link to citacepro.com

ObalkyKnihTrait::getObalkyKnihToc() — Method in class ObalkyKnihTrait

Get TOC URL

PatentTrait::getPatentInfo() — Method in class PatentTrait

Get patent info for export in txt

PatentTrait::getMpts() — Method in class PatentTrait

Get international patent classification

WikidataTrait::getWikidataData() — Method in class WikidataTrait

Get data for this authority record from wikidata

WikidataTrait::getCitedDocuments() — Method in class WikidataTrait

Get information about cited documents

WikidataTrait::getCitesFromWikidata() — Method in class WikidataTrait

Get information about cited documents from wikidata

Search2Library::getHierarchyType() — Method in class Search2Library

Get the Hierarchy Type (false if none)

SolrAuthority::getTitle() — Method in class SolrAuthority

Get the full title of the record.

SolrAuthority::getAddedEntryPersonalNames() — Method in class SolrAuthority

Get the alternatives of the full name.

SolrAuthority::getPseudonyms() — Method in class SolrAuthority

Get the authority's pseudonyms.

SolrAuthority::getSource() — Method in class SolrAuthority

Get authority's source.

SolrAuthority::getHighlightedTitle() — Method in class SolrAuthority

Get the authority's name, shown as title of record.

SolrAuthority::getSummary() — Method in class SolrAuthority

Get the authority's bibliographic details.

SolrAuthority::getBibliographicDetails() — Method in class SolrAuthority

Get the bibliographic details of authority.

SolrAuthority::getAuthorityId() — Method in class SolrAuthority

Get id_authority.

SolrAuthority::getCountByField() — Method in class SolrAuthority

Get count of results for given search

SolrAuthority::getPublicationsUrl() — Method in class SolrAuthority

Get link to search publications of authority.

SolrAuthority::getPublicationsAboutUrl() — Method in class SolrAuthority

Get link to search publications about authority.

SolrAuthority::getRelatedUrls() — Method in class SolrAuthority

Get urls related to this record, publications of this authority and publications about this authority

SolrAuthority::getThumbnail() — Method in class SolrAuthority

Returns array with one key: authority_id

SolrAuthority::getOccupation() — Method in class SolrAuthority

Get authority occupation

SolrAuthority::getCombinedAuthorityId() — Method in class SolrAuthority

Return NKCR AUT ID or OsobnostiRegionu.cz Id

SolrAuthority::getWikidataLinks() — Method in class SolrAuthority

Get links to external websites from wikidata

SolrAuthority::getWikidataQuery() — Method in class SolrAuthority

Creates query for wikidata links

SolrAuthority::getSignature() — Method in class SolrAuthority

Get image URL of this person's signature

SolrAuthority::getPronunciation() — Method in class SolrAuthority

Get sound file URL and IPA transcription of this person's name

SolrAuthority::getExternalLinksByType() — Method in class SolrAuthority

Get links to external sites/databases by type

SolrAuthority::getExternalLinks() — Method in class SolrAuthority

Get links to external sites

SolrAuthority::getIdentifiersLinks() — Method in class SolrAuthority

Get links to external databases

SolrDefault::getPublishers() — Method in class SolrDefault

Get the publishers of the record.

SolrDefault::getFormats() — Method in class SolrDefault

Get formats for display

SolrDefault::getParentRecordID() — Method in class SolrDefault

Returns parent record ID from SOLR

SolrDefault::getSourceId() — Method in class SolrDefault

Identificator of record source

SolrDefault::getIsn() — Method in class SolrDefault

Returns first of ISSNs, ISBNs and ISMNs from SOLR

SolrDefault::getBreadcrumb() — Method in class SolrDefault

Get text that can be displayed to represent this record in breadcrumbs.

SolrDefault::getTitle() — Method in class SolrDefault

Get the full title of the record.

SolrDefault::getShortTitle() — Method in class SolrDefault

Get title of record. This is for compatibility with original VuFind

SolrDefault::getSubtitle() — Method in class SolrDefault

Get the subtitle of the record.

SolrDefault::getCitationRecordType() — Method in class SolrDefault

Get record type for citation

SolrDefault::getHighlightedSnippet() — Method in class SolrDefault

Pick one line from the highlighted text (if any) to use as a snippet.

SolrDefault::getPrimaryAuthorsIds() — Method in class SolrDefault

Get authority ID of main author.

SolrDefault::getPrimaryAuthors() — Method in class SolrDefault

Get the main author of the record.

SolrDefault::getPrimaryAuthorForSorting() — Method in class SolrDefault

Get the main author of the record for sorting purposes.

SolrDefault::getSecondaryAuthors() — Method in class SolrDefault

Get an array of all secondary authors (complementing getPrimaryAuthor()).

SolrDefault::getCorporateAuthors() — Method in class SolrDefault

Get the corporate author of the record.

SolrDefault::getSecondaryAuthorsIds() — Method in class SolrDefault

Get an array of authority Ids of all secondary authors in the same order and amount as getSecondaryAuthors() method from author2 solr field.

SolrDefault::getPublicationDates() — Method in class SolrDefault

Get the publication dates of the record. See also getDateSpan().

SolrDefault::getISBNs() — Method in class SolrDefault

Get an array of all ISBNs associated with the record (may be empty).

SolrDefault::getSummary() — Method in class SolrDefault

Get an array of summary strings for the record.

SolrDefault::getMonographicSeriesFieldData() — Method in class SolrDefault

Get raw data of monographic series

SolrDefault::getMonographicSeries() — Method in class SolrDefault

Get monographic series for display

SolrDefault::getZiskejBoolean() — Method in class SolrDefault

Is record available in Ziskej service?

SolrDefault::getEddBoolean() — Method in class SolrDefault

If record is available in ZiskejEDD service

SolrDefault::getEddSubtype() — Method in class SolrDefault

Return Ziskej EDD subtype of record based on record formats

SolrDefault::getLinks() — Method in class SolrDefault

Return an array of associative URL arrays with one or more of the following keys:

  • desc: URL description text to display (optional)
  • url: fully-formed URL (required if 'route' is absent)
  • destination: web or digital library
  • status: access status
  • source: source of data
SolrDefault::get856Links() — Method in class SolrDefault

Get links from marc field 856

SolrDefault::getParentRecord() — Method in class SolrDefault

Get parent record

SolrDefault::getChildrenIds() — Method in class SolrDefault

Used in ajax to get sfx url

SolrDefault::getDeduplicatedRecords() — Method in class SolrDefault

Return deduplicated records - array with key as institution source and value with record ids or false if not supported

SolrDefault::getDeduplicatedRecordIds() — Method in class SolrDefault

Return array of all deduplicated record ids

SolrDefault::getOwningLibraryId() — Method in class SolrDefault

Get owning library id

SolrDefault::getSimilarFromSolrField() — Method in class SolrDefault

Get related record data

SolrDefault::getDeduplicatedAuthors() — Method in class SolrDefault

Deduplicate author information into associative array with main/corporate/ secondary keys.

SolrDefault::getSiglaDisplay() — Method in class SolrDefault

Get the sigla for display

SolrDefault::getGeoLocation() — Method in class SolrDefault

Get the geolocation

SolrDefault::getIdFrom001() — Method in class SolrDefault

Get id from field 001 of marc record (indexed in solr)

SolrDefault::getSerialLinks() — Method in class SolrDefault

Get links of serials to library catalogue

SolrDefault::getLinksFromSolrField() — Method in class SolrDefault

General function for getting links

SolrDefault::getRecordDataFormatterKey() — Method in class SolrDefault

Get record data formatter key

SolrDefault::getRecordDataTypeDescription() — Method in class SolrDefault

Get record data type description

SolrDefault::getCacheKey() — Method in class SolrDefault

Method to ensure uniform cache keys for cached VuFind objects.

SolrDefault::getSourceTitleFacet() — Method in class SolrDefault

Return title of source document

SolrDefault::getPlaceOfPublication() — Method in class SolrDefault

Get place of publication place

SolrDefault::getPublishDate() — Method in class SolrDefault

Get date published

SolrDefault::getPlaceOfPublicationAndPublishDate() — Method in class SolrDefault

Get place of publication and publish date

SolrDefault::getPrimaryAuthorsString() — Method in class SolrDefault

Get primary authors

SolrDefault::getIsbn() — Method in class SolrDefault

Get ISBN

SolrDictionary::getSummary() — Method in class SolrDictionary

Get explanation.

SolrDictionary::getTermAuthors() — Method in class SolrDictionary

Get term author list

SolrDictionary::getTitle() — Method in class SolrDictionary

Get name, shown as title of record.

SolrDictionary::getEnglish() — Method in class SolrDictionary

Get english term.

SolrDictionary::getRelatives() — Method in class SolrDictionary

Get relative terms.

SolrDictionary::getAlternatives() — Method in class SolrDictionary

Get alternative terms.

SolrDictionary::getSource() — Method in class SolrDictionary

Get source.

SolrDictionary::getFilterParamsForRelated() — Method in class SolrDictionary

Get handler for related

SolrDictionary::getWikidataInfo() — Method in class SolrDictionary

Get data from Wikidata

SolrDictionary::getWikidataLinks() — Method in class SolrDictionary

Get links to external websites from wikidata

SolrDublinCore::getAllSubjectHeadings() — Method in class SolrDublinCore

Get all subject headings associated with this record. Each heading is returned as an array of chunks, increasing from least specific to most specific.

SolrDublinCore::getTitle() — Method in class SolrDublinCore

Get the full title of the record.

SolrDublinCore::getSubtitle() — Method in class SolrDublinCore

Get the subtitle of the record.

SolrDublinCore::getLanguages() — Method in class SolrDublinCore

Get an array of all the languages associated with the record.

SolrDublinCore::getHumanReadablePublicationDates() — Method in class SolrDublinCore

Get human readable publication dates for display purposes (may not be suitable for computer processing -- use getPublicationDates() for that).

SolrDublinCore::getGeneralNotes() — Method in class SolrDublinCore

Get general notes on the record.

SolrDublinCore::getXmlFieldData() — Method in class SolrDublinCore

Get XML field data as array of strings

SolrDublinCore::getXML() — Method in class SolrDublinCore

Return an XML representation of the record using the specified format.

SolrLibrary::getTitle() — Method in class SolrLibrary

Get library name

SolrLibrary::getAlternativeTitles() — Method in class SolrLibrary

Get library alternative name

SolrLibrary::getTown() — Method in class SolrLibrary

Get town or city

SolrLibrary::getLibraryHours() — Method in class SolrLibrary

Get library opening hours

SolrLibrary::getLastUpdated() — Method in class SolrLibrary

Get last updated metadata date

SolrLibrary::getLibraryAddress() — Method in class SolrLibrary

Get library postal addresses

SolrLibrary::getIco() — Method in class SolrLibrary

Get an array of library ico and dicn

SolrLibrary::getLibNote() — Method in class SolrLibrary

Get notes

SolrLibrary::getLibNote2() — Method in class SolrLibrary

Get secondary notes

SolrLibrary::getSigla() — Method in class SolrLibrary

Get sigla identifier

SolrLibrary::getWebsites() — Method in class SolrLibrary

Get related URLs

SolrLibrary::getLibBranch() — Method in class SolrLibrary

Get library branches

SolrLibrary::getLibResponsibility() — Method in class SolrLibrary

Get responsible people names

SolrLibrary::getPhone() — Method in class SolrLibrary

Get phone number

SolrLibrary::getEmail() — Method in class SolrLibrary

Get email address

SolrLibrary::getService() — Method in class SolrLibrary

Get provided services

SolrLibrary::getFunction() — Method in class SolrLibrary

Get library roles

SolrLibrary::getProject() — Method in class SolrLibrary

Get projects library participates in

SolrLibrary::getType() — Method in class SolrLibrary

Get type of library

SolrLibrary::getMvs() — Method in class SolrLibrary

Get ILL service information

SolrLibrary::getBranchUrl() — Method in class SolrLibrary

Get branch URL

SolrLibrary::getBranches() — Method in class SolrLibrary

Get branches

SolrLibrary::getBookSearchFilter() — Method in class SolrLibrary

Get facet value for library represented by this record

SolrLibrary::getGpsCoordinates() — Method in class SolrLibrary

Get GPS coordinates of library

SolrLibrary::getFilterParamsForRelated() — Method in class SolrLibrary

Get handler for related

SolrLibrary::getRegLibrary() — Method in class SolrLibrary

Get Regional Library

SolrLibrary::getDeduplicatedRecords() — Method in class SolrLibrary

Return deduplicated records - array with key as institution source and value with record ids or false if not supported

SolrLibrary::getRegion() — Method in class SolrLibrary

Get translated region name

SolrLibrary::getCpkCode() — Method in class SolrLibrary

Get source code for library involved in Knihovny.cz project

SolrLibrary::getTranslatedNameBySource() — Method in class SolrLibrary

Return full name based on library source code

SolrLibrary::getCleanNBN() — Method in class SolrLibrary

Get fake NBN for getting image from Obálkyknih.cz

SolrLibrary::getFormats() — Method in class SolrLibrary

Get formats for display

SolrLibrary::getWikidataQuery() — Method in class SolrLibrary

Creates query for wikidata links

SolrLibrary::getSocialSitesLinks() — Method in class SolrLibrary

Get links to social networks

SolrLibrary::getIsds() — Method in class SolrLibrary

Get information about ISDS (datova schranka)

SolrLibrary::getCsvData() — Method in class SolrLibrary

Get data for CSV export

SolrLibrary::getSiglaSearchTxt() — Method in class SolrLibrary

Get library sigla

SolrLibrary::getRegionalLibraryTxt() — Method in class SolrLibrary

Get parent library sigla

SolrLibrary::getFunctionSearchTxtMv() — Method in class SolrLibrary

Get library functions

SolrLibrary::getRegionSearchTxt() — Method in class SolrLibrary

Get library region name

SolrLibrary::getDistrictSearchTxt() — Method in class SolrLibrary

Get library district name

SolrLibrary::getTownStr() — Method in class SolrLibrary

Get library town name

SolrLocal::getRealTimeHoldings() — Method in class SolrLocal

Get an array of information about record holdings, obtained in real-time from the ILS.

SolrLocal::getPrimaryAuthorForSorting() — Method in class SolrLocal

Get the main author of the record for sorting purposes.

SolrLocal::getOfflineHoldings() — Method in class SolrLocal

Get an array of information about record holdings, obtained in real-time from the ILS.

SolrLocal::getOfflineHoldingByItemId() — Method in class SolrLocal

Get an array of offline information about holding by item id

SolrLocal::getOfflineHoldingByBarcode() — Method in class SolrLocal

Get an array of offline information about holding by barcode

SolrMarc::getISSNFromMarc() — Method in class SolrMarc

ISSN from marc record

SolrMarc::getScales() — Method in class SolrMarc

Cartographic material scale from marc record

SolrMarc::getEdition() — Method in class SolrMarc

Get the edition of the current record.

SolrMarc::getRange() — Method in class SolrMarc

Returns document range info from field 300

SolrMarc::getNonStandardISBN() — Method in class SolrMarc

Non-standard ISBNs from marc record

SolrMarc::getStructuredDataFieldArray() — Method in class SolrMarc

Get field and its subfields as array

SolrMarc::getField773() — Method in class SolrMarc

Marc field 773

SolrMarc::getField770() — Method in class SolrMarc

Marc field 770

SolrMarc::getField772() — Method in class SolrMarc

Marc field 772

SolrMarc::getField777() — Method in class SolrMarc

Marc field 777

SolrMarc::getField780() — Method in class SolrMarc

Marc field 780

SolrMarc::getField785() — Method in class SolrMarc

Marc field 785

SolrMarc::getFilterParamsForRelated() — Method in class SolrMarc

Get handler for related

SolrMarc::getSummary() — Method in class SolrMarc

Get an array of summary strings for the record.

SolrMarc::getItemIds() — Method in class SolrMarc

Get all item identifiers for this record

SolrMarc::getURLs() — Method in class SolrMarc

Return an array of associative URL arrays with one or more of the following keys:

SolrMarc::getPhysicalDescriptions() — Method in class SolrMarc

Get an array of physical descriptions of the item.

SolrMarc::getCleanNBN() — Method in class SolrMarc

Get just the first listed national bibliography number (or false if none available).

SolrMarc::getReviews() — Method in class SolrMarc

Get reviews

SolrMarc::getLocalIdForObalkyKnih() — Method in class SolrMarc

Get identifier stripped of all prefixes

SolrMarc::getFieldCitation() — Method in class SolrMarc

Get citation (parsed from field 773)

SolrMarc::getIssnFromField773() — Method in class SolrMarc

Get ISSN (parsed from field 773)

SolrMarc::getISSN() — Method in class SolrMarc

Get ISSN field

SolrMarc::getYearFromField773() — Method in class SolrMarc

Get year (parsed from field 773)

SolrMarc::getPYearFromField773() — Method in class SolrMarc

Get periodical volume (parsed from field 773)

SolrMarc::getPNumberFromField773() — Method in class SolrMarc

Get periodical issue (parsed from field 773)

Summon::getFullTextLinks() — Method in class Summon

Get fulltext links

Summon::getCacheKey() — Method in class Summon

Method to ensure uniform cache keys for cached VuFind objects.

Buy::getDescription() — Method in class Buy

Get the on-screen description for this tab.

Cites::getDescription() — Method in class Cites

Get the on-screen description for this tab.

DedupedRecords::getDescription() — Method in class DedupedRecords

Get the on-screen description for this tab.

EVersion::getDescription() — Method in class EVersion

Get the on-screen description for this tab.

LibraryBranches::getDescription() — Method in class LibraryBranches

Get the on-screen description for this tab.

LibraryContacts::getDescription() — Method in class LibraryContacts

Get the on-screen description for this tab.

LibraryInfo::getDescription() — Method in class LibraryInfo

Get the on-screen description for this tab.

LibraryServices::getDescription() — Method in class LibraryServices

Get the on-screen description for this tab.

SfxAvailability::getDescription() — Method in class SfxAvailability

Get the on-screen description for this tab.

StaffViewDublinCore::getDescription() — Method in class StaffViewDublinCore

Get the on-screen description for this tab.

ZiskejBase::getServerName() — Method in class ZiskejBase

Get server name

ZiskejBase::getEntityId() — Method in class ZiskejBase

Get entity id

ZiskejBase::getDedupedRecordIds() — Method in class ZiskejBase

Get deduplicated record ids

ZiskejBase::getConnectedLibs() — Method in class ZiskejBase

Get libraries connected in Ziskej

ZiskejEdd::getDescription() — Method in class ZiskejEdd

Get the on-screen description for this tab.

ZiskejEdd::getZiskejEdd() — Method in class ZiskejEdd

Get ZiskejEdd class

ZiskejEdd::getZiskejLibsIds() — Method in class ZiskejEdd

Get ids of active libraries in Ziskej

ZiskejMvs::getDescription() — Method in class ZiskejMvs

Get the on-screen description for this tab.

ZiskejMvs::getZiskejMvs() — Method in class ZiskejMvs

Get ZiskejMvs class

ZiskejMvs::getZiskejLibsIds() — Method in class ZiskejMvs

Get ids of active libraries in Ziskej

Links::getLinks() — Method in class Links

Get an array of external links

Links::getLabel() — Method in class Links

Get label for related module

SolrField::getResults() — Method in class SolrField

Get an array of StdObjects representing items similar to the one passed to the constructor.

Search2BackendFactory::getCreateRecordCallback() — Method in class Search2BackendFactory

Get the callback for creating a record.

SolrDefaultBackendFactory::getJsonFacetListener() — Method in class SolrDefaultBackendFactory

Get a JSON facet listener for the backend

SolrDefaultBackendFactory::getDeduplicationListener() — Method in class SolrDefaultBackendFactory

Get a deduplication listener for the backend

SolrDefaultBackendFactory::getDeduplicationType() — Method in class SolrDefaultBackendFactory

Return deduplication type to use

PerformanceLogger::getHeader() — Method in class PerformanceLogger

Get header value

PerformanceLogger::getHeaderFromResponse() — Method in class PerformanceLogger

Get header value

PerformanceLogger::getUrl() — Method in class PerformanceLogger

Get URL

RecordCollection::getFacets() — Method in class RecordCollection

Return SOLR facet information.

ChildDocDeduplicationListener::getLocalRecordIds() — Method in class ChildDocDeduplicationListener

Return local record ids

ChildDocDeduplicationListener::getListOfFields() — Method in class ChildDocDeduplicationListener

Return list of fields to fetch from Solr

ChildDocDeduplicationListener::getChildListOfFields() — Method in class ChildDocDeduplicationListener

Return new list of fields to fetch from Solr for child record

DeduplicationListener::getSourcesFromLibraryCards() — Method in class DeduplicationListener

Get institutions from user's library cards

DeduplicationListener::getSourcesFromFilters() — Method in class DeduplicationListener

Get sources from facet filters

DeduplicationListener::getNonPreferredSources() — Method in class DeduplicationListener

Get non preferred sources

JsonFacetListener::getFacetParameter() — Method in class JsonFacetListener

Return facet parameter

JsonFacetListener::getFacetConfig() — Method in class JsonFacetListener

Get configuration for nested facet

OneChildDocDeduplicationListener::getChildListOfFields() — Method in class OneChildDocDeduplicationListener

Return new list of fields to fetch from Solr for child record

Params::getBackendParameters() — Method in class Params

Create search backend parameters for advanced features.

Results::getUrlQueryHelperFactory() — Method in class Results

Get URL query helper factory

CitaceProService::getCitation() — Method in class CitaceProService

Get citation style

CitaceProService::getCitationLink() — Method in class CitaceProService

Get link to citacepro.com

CitaceProService::getCitationStyles() — Method in class CitaceProService

Get available citation styles

CitaceProService::getDefaultCitationStyle() — Method in class CitaceProService

Get default citation style

GoogleBooksLinkServiceClass in namespace KnihovnyCz\Service

Class GoogleBooksLinkService

GoogleBooksLinkService::getLink() — Method in class GoogleBooksLinkService

Get link to record representation on given service

GuzzleHttpServiceClass in namespace KnihovnyCz\Service

Class GuzzleHttpService

GuzzleHttpServiceFactoryClass in namespace KnihovnyCz\Service

KnihovnyCz Guzzle HTTP Service factory.

LinkServiceAbstractBase::getDataFromService() — Method in class LinkServiceAbstractBase

Get data from service as array

LinkServiceInterface::getLink() — Method in class LinkServiceInterface

Get link to record representation on given service

UserSettingsService::getAvailableSettings() — Method in class UserSettingsService

Get available settings

UserSettingsService::getUserSettings() — Method in class UserSettingsService

Get or create user settings for logged in user

WayfFilterGenerator::generate() — Method in class WayfFilterGenerator

Generate filter

ZboziLinkService::getLink() — Method in class ZboziLinkService

Get link to record representation on given service

NullSessionManager::getName() — Method in class NullSessionManager

Get session name

NullSessionManager::getId() — Method in class NullSessionManager

Get session ID

NullSessionManager::getValidatorChain() — Method in class NullSessionManager

Get the validator chain to use when validating a session

Index::getUrls() — Method in class Index

Generate urls for the sitemap.

DatabaseCsrf::getHash() — Method in class DatabaseCsrf

Retrieve CSRF token

DatabaseCsrf::getMessages() — Method in class DatabaseCsrf

Returns an array of messages that explain why the most recent isValid() call returned false. The array keys are validation failure message identifiers, and the array values are the corresponding human-readable message strings.

GeoCoordsClass in namespace KnihovnyCz\View\Helper\KnihovnyCz

Class GeoCoords

GeoCoords::getSearchUrl() — Method in class GeoCoords

Get search URL if geo search is enabled for the specified search class ID, false if disabled.

GoogleTagManagerClass in namespace KnihovnyCz\View\Helper\KnihovnyCz

Class GoogleTagManager

GoogleTagManager::getRawJavascript() — Method in class GoogleTagManager

Returns GTM Javascript code.

GoogleTagManager::getCode() — Method in class GoogleTagManager

Returns GTM Javascript code.

GoogleTagManager::getNoScriptCode() — Method in class GoogleTagManager

Returns GTM noscript alternative code.

GoogleTagManagerFactoryClass in namespace KnihovnyCz\View\Helper\KnihovnyCz

Class GoogleTagManagerFactory

LibrariesApiLookfor::getLookfor() — Method in class LibrariesApiLookfor

Create lookfor string, translate advanced search query into basic to be used as query string for search API

LibrariesApiLookfor::getLookforFromQueryGroup() — Method in class LibrariesApiLookfor

Return lookfor string for query group

LibrariesApiLookfor::getLookforFromQuery() — Method in class LibrariesApiLookfor

Return lookfor string for one query

RecordDataFormatterFactory::getDefaultLibraryCoreSpecs() — Method in class RecordDataFormatterFactory

Library record detail display specifications

RecordDataFormatterFactory::getDefaultLibraryCoreFields() — Method in class RecordDataFormatterFactory

Utitity function for getting fields for library core metadata

RecordDataFormatterFactory::getDefaultDictionaryCoreSpecs() — Method in class RecordDataFormatterFactory

Dictionary record detail display specifications

RecordDataFormatterFactory::getDefaultAuthorityCoreSpecs() — Method in class RecordDataFormatterFactory

Authority record detail display specifications

RecordDataFormatterFactory::getDefaultCoreSpecs() — Method in class RecordDataFormatterFactory

Get default specifications for displaying data in core metadata.

RecordDataFormatterFactory::getDefaultZiskejCoreSpecs() — Method in class RecordDataFormatterFactory

Get default specs for detailed view of document in Ziskej service

RecordLinker::getLinkToMainPortal() — Method in class RecordLinker

Return a link to main portal

RecordLinker::getLinkToLocalRecord() — Method in class RecordLinker

Given a record driver, get a URL for that record that links to local record.

RecordLinker::getControllerName() — Method in class RecordLinker

Given a record driver, get a controller for that record.

UserCards::getSortedByLibraryName() — Method in class UserCards

Get user cards sorted by library name

ZiskejEdd::getCurrentMode() — Method in class ZiskejEdd

Get current Ziskej mode

ZiskejEdd::getModes() — Method in class ZiskejEdd

Get available Ziskej modes

ZiskejMvs::getCurrentMode() — Method in class ZiskejMvs

Get current Ziskej mode

ZiskejMvs::getModes() — Method in class ZiskejMvs

Get available Ziskej modes

ZiskejMvs::getStatusClass() — Method in class ZiskejMvs

Get html class attribute

SparqlService::getHttpClient() — Method in class SparqlService

Get HTTP client

SparqlService::getHeaders() — Method in class SparqlService

Get headers

Ziskej::getUrls() — Method in class Ziskej

Get list of Ziskej API urls

Ziskej::getModes() — Method in class Ziskej

Get list of Ziskej API modes

Ziskej::getCurrentMode() — Method in class Ziskej

Get current mode

Ziskej::getCurrentUrl() — Method in class Ziskej

Get current base url

Ziskej::getPrivateKeyFileLocation() — Method in class Ziskej

Get location of private key file

Ziskej::getZiskejTechlibUrl() — Method in class Ziskej

Get techlib url

Ziskej::getCurrentZiskejTechlibFrontUrl() — Method in class Ziskej

Get current techlib front url

FeedbackController::getParam() — Method in class FeedbackController

Get the url parameters

FeedbackController::getConfirmDeleteMessages() — Method in class FeedbackController

Get messages for confirm delete

FeedbackController::getFeedbackTable() — Method in class FeedbackController

Get Feedback table

FeedbackController::getUniqueColumn() — Method in class FeedbackController

Get unique values for a column

FeedbackController::getStatuses() — Method in class FeedbackController

Get available feedback statuses

OverdriveController::getParam() — Method in class OverdriveController

Get the url parameters

TagsController::getParam() — Method in class TagsController

Get the url parameters

TagsController::getConfirmDeleteMessages() — Method in class TagsController

Get confirmation messages.

TagsController::getUniqueResources() — Method in class TagsController

Gets a list of unique resources based on the url params

TagsController::getUniqueTags() — Method in class TagsController

Gets a list of unique tags based on the url params

TagsController::getUniqueUsers() — Method in class TagsController

Gets a list of unique users based on the url params

TagsController::getResourceTags() — Method in class TagsController

Get and set a list of resource tags

Module::getConfig() — Method in class Module

Get module configuration

Module::getAutoloaderConfig() — Method in class Module

Get autoloader configuration

AdminApiController::getApiSpecFragment() — Method in class AdminApiController

Get API specification JSON fragment for services provided by the controller

AdminApiController::getDefaultCachesToClear() — Method in class AdminApiController

Get an array of caches to clear by default

ApiController::getApiSpecFragment() — Method in class ApiController

Get API specification JSON fragment for the root nodes

ApiController::getApiSpecs() — Method in class ApiController

Merge specification fragments from all APIs to an array

ApiControllerFactory::getApiControllersToRegister() — Method in class ApiControllerFactory

Get the API controllers to register with ApiController

ApiInterface::getApiSpecFragment() — Method in class ApiInterface

Get API specification JSON fragment for services provided by the controller

SearchApiController::getApiSpecFragment() — Method in class SearchApiController

Get API specification JSON fragment for services provided by the controller

SearchApiController::getHierarchicalFacetData() — Method in class SearchApiController

Get hierarchical facet data for the given facet fields

SearchApiController::getFieldList() — Method in class SearchApiController

Get field list based on the request

RecordFormatter::getDedupIds() — Method in class RecordFormatter

Get dedup IDs

RecordFormatter::getExtendedSubjectHeadings() — Method in class RecordFormatter

Get extended subject headings

RecordFormatter::getFullRecord() — Method in class RecordFormatter

Get full record for a record as XML

RecordFormatter::getRawData() — Method in class RecordFormatter

Get raw data for a record as an array

RecordFormatter::getRecordPage() — Method in class RecordFormatter

Get (relative) link to record page

RecordFormatter::getURLs() — Method in class RecordFormatter

Get URLs

RecordFormatter::getFields() — Method in class RecordFormatter

Get fields from a record as an array

RecordFormatter::getRecordFields() — Method in class RecordFormatter

Get record field definitions.

RecordFormatter::getRecordFieldSpec() — Method in class RecordFormatter

Return record field specs for the API specification

Module::getConfig() — Method in class Module

Get module configuration

Module::getAutoloaderConfig() — Method in class Module

Get autoloader configuration

$ AbstractCommand#generatorToolsProperty in class AbstractCommand

Generator tools

$ AbstractThemeCommand#generatorProperty in class AbstractThemeCommand

Theme resource generator

AbstractThemeCommand::generate() — Method in class AbstractThemeCommand

Run the generator.

ThemeCommand::generate() — Method in class ThemeCommand

Run the generator.

HarvestOaiCommandFactory::getHarvestRoot() — Method in class HarvestOaiCommandFactory

Get the base directory for harvesting OAI-PMH data.

InstallCommand::getWindowsApacheMessage() — Method in class InstallCommand

Get instructions for editing the Apache configuration under Windows.

InstallCommand::getLinuxApacheMessage() — Method in class InstallCommand

Get instructions for editing the Apache configuration under Linux.

InstallCommand::getApacheLocation() — Method in class InstallCommand

Display system-specific information for where configuration files are found and/or symbolic links should be created.

InstallCommand::getBasePath() — Method in class InstallCommand

Get a base path from the user (or return a default).

InstallCommand::getOverrideDir() — Method in class InstallCommand

Get an override directory from the user (or return a default).

InstallCommand::getModule() — Method in class InstallCommand

Get the custom module name from the user (or blank for none).

InstallCommand::getMultisiteMode() — Method in class InstallCommand

Get the user's preferred multisite mode.

InstallCommand::getHost() — Method in class InstallCommand

Get the user's hostname preference.

InstallCommand::getInput() — Method in class InstallCommand

Fetch a single line of input from the user.

AbstractCommand::getLangDir() — Method in class AbstractCommand

Open the language directory as an object using dir(). Return false on failure.

PluginManager::getCommandList() — Method in class PluginManager

Get a list of all available commands in the plugin manager.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

NotifyCommand::getUserForSearch() — Method in class NotifyCommand

Load and validate a user object associated with the search; return false if there is a problem.

NotifyCommand::getObjectForSearch() — Method in class NotifyCommand

Load and validate the results object associated with the search; return false if there is a problem.

NotifyCommand::getNewRecords() — Method in class NotifyCommand

Given a search results object, fetch records that have changed since the last search. Return false on error.

AbstractCssBuilderCommand::getCompiler() — Method in class AbstractCssBuilderCommand

Build the compiler.

AbstractExpireCommand::getTimestampedMessage() — Method in class AbstractExpireCommand

Add a time stamp to a message

AbstractExpireCommand::getDateThreshold() — Method in class AbstractExpireCommand

Convert days to a date threshold

DedupeCommand::getInput() — Method in class DedupeCommand

Fetch a single line of input from the user.

DeletesCommand::getIdsFromFlatFile() — Method in class DeletesCommand

Load IDs from a flat file.

DeletesCommand::getIdsFromMarcFile() — Method in class DeletesCommand

Load IDs from a MARC file

IndexReservesCommand::getCsvReader() — Method in class IndexReservesCommand

Construct a CSV reader.

ScssBuilderCommand::getCompiler() — Method in class ScssBuilderCommand

Build the LESS compiler.

$ SitemapCommand#generatorProperty in class SitemapCommand

Sitemap generator

SwitchDbHashCommand::getConfigWriter() — Method in class SwitchDbHashCommand

Get a config writer

SwitchDbHashCommand::getOpenSsl() — Method in class SwitchDbHashCommand

Get an OpenSsl object for the specified algorithm (or return null if the algorithm is 'none').

ConsoleRunner::getCommandList() — Method in class ConsoleRunner

Get the command or list of commands to run.

GeneratorToolsClass in namespace VuFindConsole\Generator

Generator tools.

GeneratorTools::getPluginManagerForNamespace() — Method in class GeneratorTools

Determine a plugin manager name within the specified namespace.

GeneratorTools::getVuFindExtendedModules() — Method in class GeneratorTools

Get a list of VuFind modules (only those with names beginning with VuFind, and not including the core VuFind module itself).

GeneratorTools::getPluginManagerFromExplodedClassName() — Method in class GeneratorTools

Given a class name exploded into an array, figure out the appropriate plugin manager to use.

GeneratorTools::getShortNameFromExplodedClassName() — Method in class GeneratorTools

Given a class name exploded into an array, figure out the appropriate short name to use as an alias in the service manager configuration.

GeneratorTools::getExpectedInterfaceFromPluginManager() — Method in class GeneratorTools

Given a plugin manager object, return the interface plugins of that type must implement.

GeneratorTools::getConfigPathForClass() — Method in class GeneratorTools

Given a plugin manager class name, return the configuration path for that plugin manager.

GeneratorTools::getPluginManagerForClassParts() — Method in class GeneratorTools

Given appropriate inputs, figure out which plugin manager or service manager to use during plugin generation.

GeneratorTools::generateFactory() — Method in class GeneratorTools

Generate a factory class.

GeneratorTools::getAllFactoriesFromContainer() — Method in class GeneratorTools

Get a list of factories in the provided container.

GeneratorTools::getFactoryFromContainer() — Method in class GeneratorTools

Get a factory from the provided container (or null if undefined).

GeneratorTools::getAllDelegatorsFromContainer() — Method in class GeneratorTools

Get a list of delegators in the provided container.

GeneratorTools::getDelegatorsFromContainer() — Method in class GeneratorTools

Get delegators from the provided container (or empty array if undefined).

GeneratorTools::getPluginManagerContainingClass() — Method in class GeneratorTools

Search all plugin managers for one containing the requested class (or return null if none found).

GeneratorTools::generateLocalClassName() — Method in class GeneratorTools

Determine the name of a local replacement class within the specified module.

GeneratorTools::getModuleConfigPath() — Method in class GeneratorTools

Get the path to the module configuration; throw an exception if it is missing.

GeneratorToolsFactoryClass in namespace VuFindConsole\Generator

Generator tools factory.

Module::getConfig() — Method in class Module

Get module configuration

Module::getAutoloaderConfig() — Method in class Module

Get autoloader configuration

DevtoolsController::getQueryBuilder() — Method in class DevtoolsController

Fetch the query builder for the specified search backend. Return null if unavailable.

LanguageHelper::getHelpFiles() — Method in class LanguageHelper

Get a list of help files in the specified language.

LanguageHelper::getLanguages() — Method in class LanguageHelper

Get a list of languages supported by VuFind:

LanguageHelper::getLangName() — Method in class LanguageHelper

Get English name of language

LanguageHelper::getTextDomains() — Method in class LanguageHelper

Get text domains for a language.

LanguageHelper::getLanguageDetails() — Method in class LanguageHelper

Return details on how $langCode differs from $main.

LanguageHelper::getAllLanguageDetails() — Method in class LanguageHelper

Return details on how all languages differ from $main.

LanguageHelper::getAllDetails() — Method in class LanguageHelper

Return language comparison information, using $mainLanguage as the baseline.

Module::getConfig() — Method in class Module

Get module configuration

Module::getAutoloaderConfig() — Method in class Module

Get autoloader configuration

Module::getConfig() — Method in class Module

Get module configuration

Module::getAutoloaderConfig() — Method in class Module

Get autoloader configuration

AbstractBackend::getIdentifier() — Method in class AbstractBackend

Return backend identifier.

AbstractBackend::getRecordCollectionFactory() — Method in class AbstractBackend

Return the record collection factory.

AbstractHandlerMap::getInvariants() — Method in class AbstractHandlerMap

Return query invariants for search function.

AbstractHandlerMap::getDefaults() — Method in class AbstractHandlerMap

Return query defaults for search function.

AbstractHandlerMap::getAppends() — Method in class AbstractHandlerMap

Return query appends for search function.

BackendInterface::getIdentifier() — Method in class BackendInterface

Return backend identifier.

Backend::getRecordCollectionFactory() — Method in class Backend

Return the record collection factory.

Backend::getActiveBackends() — Method in class Backend

Get active backends for a search

Backend::getRecord() — Method in class Backend

Get next record from the given backend.

Backend::getBlockSize() — Method in class Backend

Get the block size for the given result count

RecordCollection::getErrors() — Method in class RecordCollection

Return any errors.

RecordCollection::getFacetDelimiter() — Method in class RecordCollection

Get delimiter for the given facet field

RecordCollection::getBackendAtPosition() — Method in class RecordCollection

Calculate the backend to be used for a record at the given position

RecordCollection::getMergedFacets() — Method in class RecordCollection

Merge facets

RecordCollection::getHierarchyParentKeys() — Method in class RecordCollection

Get parent hierachy keys for a facet value

RecordCollection::getBlenderFacetStats() — Method in class RecordCollection

Get facet counts for Blender backend facet

Backend::getQueryBuilder() — Method in class Backend

Return query builder.

Backend::getRecordCollectionFactory() — Method in class Backend

Return the record collection factory.

Backend::getConnector() — Method in class Backend

Return the BrowZine connector.

LookupDoiCommand::getArguments() — Method in class LookupDoiCommand

Return search backend interface method arguments.

LookupDoiCommand::getDoi() — Method in class LookupDoiCommand

Return DOI to look up.

LookupIssnsCommand::getArguments() — Method in class LookupIssnsCommand

Return search backend interface method arguments.

LookupIssnsCommand::getIssns() — Method in class LookupIssnsCommand

Return ISSNs to look up.

Connector::getUri() — Method in class Connector

Get a full request URL for a relative path

RecordCollection::getTotal() — Method in class RecordCollection

Return total number of records found.

RecordCollection::getFacets() — Method in class RecordCollection

Return facet information.

RecordCollection::getOffset() — Method in class RecordCollection

Return offset in the total search result set.

ApiException::getApiError() — Method in class ApiException

Get the Api Error message details.

ApiException::getApiErrorCode() — Method in class ApiException

Known api error code

ApiException::getApiErrorDescription() — Method in class ApiException

Known api error description

ApiException::getApiDetailedErrorDescription() — Method in class ApiException

Known api detailed error description

Backend::getRecordCollectionFactory() — Method in class Backend

Return the record collection factory.

Backend::getQueryBuilder() — Method in class Backend

Return query builder.

Backend::getAuthenticationToken() — Method in class Backend

Obtain the authentication to use with the EDS API from cache if it exists. If not, then generate a new one.

Backend::getAutocompleteData() — Method in class Backend

Obtain the autocomplete authentication to use with the EDS API from cache if it exists. If not, then generate a new set.

Backend::getSessionToken() — Method in class Backend

Obtain the session token from the Session container. If it doesn't exist, generate a new one.

Backend::getInfo() — Method in class Backend

Obtain data from the INFO method

AutocompleteCommand::getArguments() — Method in class AutocompleteCommand

Return search backend interface method arguments.

AutocompleteCommand::getQuery() — Method in class AutocompleteCommand

Return simple query string.

AutocompleteCommand::getDomain() — Method in class AutocompleteCommand

Return autocomplete type.

GetInfoCommandClass in namespace VuFindSearch\Backend\EDS\Command

Get information from the EDS backend

GetInfoCommand::getArguments() — Method in class GetInfoCommand

Return search backend interface method arguments.

RecordCollection::getTotal() — Method in class RecordCollection

Return total number of records found.

RecordCollection::getRawFacets() — Method in class RecordCollection

Return raw available facet information.

RecordCollection::getFacets() — Method in class RecordCollection

Return available facets.

RecordCollection::getOffset() — Method in class RecordCollection

Return offset in the total search result set.

SearchRequestModel::getIndexedParameterName() — Method in class SearchRequestModel

Get the querystring parameter name of an indexed parameter to send to the Eds Api

Backend::getQueryBuilder() — Method in class Backend

Return query builder.

Backend::getRecordCollectionFactory() — Method in class Backend

Return the record collection factory.

Backend::getConnector() — Method in class Backend

Return the EIT connector.

Connector::getRecord() — Method in class Connector

Retrieve a specific record.

RecordCollection::getTotal() — Method in class RecordCollection

Return total number of records found.

RecordCollection::getFacets() — Method in class RecordCollection

Return facet information.

RecordCollection::getOffset() — Method in class RecordCollection

Return offset in the total search result set.

BackendException::getTags() — Method in class BackendException

Return all tags.

DeepPagingException::getLegalPage() — Method in class DeepPagingException

Get a legal page we can redirect the user to.

HttpErrorException::getResponse() — Method in class HttpErrorException

Return server response.

ConnectorCacheTrait::getCacheKey() — Method in class ConnectorCacheTrait

Create a cache key from client's request state

ConnectorCacheTrait::getCachedData() — Method in class ConnectorCacheTrait

Get a request from cache if available

Backend::getQueryBuilder() — Method in class Backend

Return query builder.

Backend::getRecordCollectionFactory() — Method in class Backend

Return the record collection factory.

Backend::getConnector() — Method in class Backend

Return the Primo connector.

RecordCollection::getTotal() — Method in class RecordCollection

Return total number of records found.

RecordCollection::getFacets() — Method in class RecordCollection

Return facet information.

RecordCollection::getOffset() — Method in class RecordCollection

Return offset in the total search result set.

Backend::getQueryBuilder() — Method in class Backend

Return query builder.

Backend::getRecordCollectionFactory() — Method in class Backend

Return the record collection factory.

Backend::getConnector() — Method in class Backend

Return the Summon connector.

Backend::getSearchProgress() — Method in class Backend

Get progress on the current search operation.

Record::getXML() — Method in class Record

Get the XML document representation

RecordCollection::getTotal() — Method in class RecordCollection

Return total number of records found.

RecordCollection::getFacets() — Method in class RecordCollection

Return facet information.

Backend::getQueryBuilder() — Method in class Backend

Return query builder.

Backend::getRecordCollectionFactory() — Method in class Backend

Return the record collection factory.

Backend::getConnector() — Method in class Backend

Return the Primo connector.

Connector::getRecord() — Method in class Connector

Retrieves a document specified by the ID.

Connector::getRecords() — Method in class Connector

Retrieves multiple documents specified by the ID.

Connector::getInstitutionCode() — Method in class Connector

Get the institution code based on user IP. If user is coming from off campus return

RecordCollection::getTotal() — Method in class RecordCollection

Return total number of records found.

RecordCollection::getFacets() — Method in class RecordCollection

Return available facets.

RecordCollection::getOffset() — Method in class RecordCollection

Return offset in the total search result set.

RecordCollection::getErrors() — Method in class RecordCollection

Return any errors.

Connector::getMoreLikeThis() — Method in class Connector

Get records similar to one record

Backend::getIds() — Method in class Backend

Perform a search and return record collection of only record identifiers.

Backend::getQueryBuilder() — Method in class Backend

Return query builder.

Backend::getSimilarBuilder() — Method in class Backend

Return similar records query builder.

Backend::getRecordCollectionFactory() — Method in class Backend

Return the record collection factory.

Backend::getConnector() — Method in class Backend

Return the SOLR connector.

RawJsonSearchCommand::getArguments() — Method in class RawJsonSearchCommand

Return search backend interface method arguments.

WriteDocumentCommand::getArguments() — Method in class WriteDocumentCommand

Return search backend interface method arguments.

WriteDocumentCommand::getDocument() — Method in class WriteDocumentCommand

Return document to write.

WriteDocumentCommand::getTimeout() — Method in class WriteDocumentCommand

Return timeout value.

WriteDocumentCommand::getHandler() — Method in class WriteDocumentCommand

Return handler to use.

Connector::getUrl() — Method in class Connector

Get the Solr URL.

Connector::getMap() — Method in class Connector

Return handler map.

Connector::getUniqueKey() — Method in class Connector

Get unique key.

Connector::getCore() — Method in class Connector

Extract the Solr core from the connector's URL.

CommitDocument::getContentType() — Method in class CommitDocument

Return content MIME type.

CommitDocument::getContent() — Method in class CommitDocument

Return serialized representation.

DeleteDocument::getContentType() — Method in class DeleteDocument

Return content MIME type.

DeleteDocument::getContent() — Method in class DeleteDocument

Return serialized representation.

DocumentInterface::getContentType() — Method in class DocumentInterface

Return content MIME type.

DocumentInterface::getContent() — Method in class DocumentInterface

Return serialized representation.

OptimizeDocument::getContentType() — Method in class OptimizeDocument

Return content MIME type.

OptimizeDocument::getContent() — Method in class OptimizeDocument

Return serialized representation.

RawDocument::getContentType() — Method in class RawDocument

Return content MIME type.

RawDocument::getContent() — Method in class RawDocument

Return serialized representation.

UpdateDocument::getContentType() — Method in class UpdateDocument

Return content MIME type.

UpdateDocument::getContent() — Method in class UpdateDocument

Return serialized representation.

HandlerMap::getHandler() — Method in class HandlerMap

Return function handler.

HandlerMap::getInvariants() — Method in class HandlerMap

Return query invariants for search function.

HandlerMap::getDefaults() — Method in class HandlerMap

Return query defaults for search function.

HandlerMap::getAppends() — Method in class HandlerMap

Return query appends for search function.

HandlerMap::getParameters() — Method in class HandlerMap

Return handler defauls, appends, or invariants.

LuceneSyntaxHelper::getBoolsToCap() — Method in class LuceneSyntaxHelper

Convert the caseSensitiveBooleans property into an array for use with the capitalizeBooleans function.

$ QueryBuilder#globalExtraParamsProperty in class QueryBuilder

Global extra Solr query parameters

QueryBuilder::getSearchTypes() — Method in class QueryBuilder

Get an array of search types used in the given search

QueryBuilder::getFieldsToHighlight() — Method in class QueryBuilder

Get list of fields to highlight, filtered by array.

QueryBuilder::getLuceneHelper() — Method in class QueryBuilder

Get Lucene syntax helper

QueryBuilder::getSearchHandler() — Method in class QueryBuilder

Return named search handler.

QueryBuilder::getNormalizedQueryString() — Method in class QueryBuilder

Given a Query object, return a fully normalized version of the query string.

SerializableRecord::getFields() — Method in class SerializableRecord

Return array of fields indexed by field name.

SerializableRecordInterface::getFields() — Method in class SerializableRecordInterface

Return array of fields indexed by field name.

RecordCollection::getSpellcheck() — Method in class RecordCollection

Return spellcheck information.

RecordCollection::getTotal() — Method in class RecordCollection

Return total number of records found.

RecordCollection::getFacets() — Method in class RecordCollection

Return available facets.

RecordCollection::getQueryFacets() — Method in class RecordCollection

Return available query facets.

RecordCollection::getPivotFacets() — Method in class RecordCollection

Return available pivot facets.

RecordCollection::getGroups() — Method in class RecordCollection

Get grouped results.

RecordCollection::getHighlighting() — Method in class RecordCollection

Get highlighting details.

RecordCollection::getCursorMark() — Method in class RecordCollection

Get cursorMark.

RecordCollection::getSolrParameters() — Method in class RecordCollection

Get raw Solr input parameters from the response.

RecordCollection::getSpellcheckQuery() — Method in class RecordCollection

Extract the best matching Spellcheck query from the raw Solr input parameters.

RecordCollection::getRawSpellcheckSuggestions() — Method in class RecordCollection

Get raw Solr Spellcheck suggestions.

Spellcheck::getQuery() — Method in class Spellcheck

Get spelling query.

Spellcheck::getSecondary() — Method in class Spellcheck

Get secondary suggestions (or return false if none exist).

Spellcheck::getIterator() — Method in class Spellcheck

Return aggregated iterator.

Terms::getIterator() — Method in class Terms

Return aggregated iterator.

Terms::getFieldTerms() — Method in class Terms

Get terms for the specified field

SearchHandler::getDismaxHandler() — Method in class SearchHandler

Get the name of the Dismax handler to be used with this search.

SearchHandler::getAllFields() — Method in class SearchHandler

Get a list of all Solr fields searched by this handler.

SearchHandler::getDismaxFields() — Method in class SearchHandler

Return defined dismax fields.

SearchHandler::getDismaxParams() — Method in class SearchHandler

Return defined dismax parameters.

SearchHandler::getFilterQuery() — Method in class SearchHandler

Return the filter query.

Backend::getQueryBuilder() — Method in class Backend

Return query builder.

Backend::getRecordCollectionFactory() — Method in class Backend

Return the record collection factory.

Backend::getConnector() — Method in class Backend

Return the Summon connector.

BackendTest::getConnectorMock() — Method in class BackendTest

Return connector mock.

QueryBuilder::getLuceneHelper() — Method in class QueryBuilder

Get Lucene syntax helper

RecordCollection::getTotal() — Method in class RecordCollection

Return total number of records found.

RecordCollection::getFacets() — Method in class RecordCollection

Return facet information.

RecordCollection::getSpellcheck() — Method in class RecordCollection

Get spelling suggestions.

RecordCollection::getBestBets() — Method in class RecordCollection

Get best bets from Summon, if any.

RecordCollection::getDatabaseRecommendations() — Method in class RecordCollection

Get database recommendations from Summon, if any.

RecordCollection::getTopicRecommendations() — Method in class RecordCollection

Get topic recommendations from Summon, if any.

Backend::getQueryBuilder() — Method in class Backend

Return query builder.

Backend::getRecordCollectionFactory() — Method in class Backend

Return the record collection factory.

Backend::getHoldings() — Method in class Backend

Get holdings information for the specified record.

Backend::getConnector() — Method in class Backend

Return the WorldCat connector.

GetHoldingsCommandClass in namespace VuFindSearch\Backend\WorldCat\Command

Command to fetch holdings from the WorldCat backend.

GetHoldingsCommand::getArguments() — Method in class GetHoldingsCommand

Return search backend interface method arguments.

Connector::getHoldings() — Method in class Connector

Get holdings information for the specified record.

Connector::getRecord() — Method in class Connector

Retrieve a specific record.

Record::getMarc() — Method in class Record

Get MARC record

RecordCollection::getTotal() — Method in class RecordCollection

Return total number of records found.

RecordCollection::getFacets() — Method in class RecordCollection

Return facet information.

AbstractBase::getTargetIdentifier() — Method in class AbstractBase

Return target backend identifier.

AbstractBase::getResult() — Method in class AbstractBase

Return result of executed operation.

AbstractBase::getSearchParameters() — Method in class AbstractBase

Return search parameters.

AbstractBase::getContext() — Method in class AbstractBase

Return command context.

AlphabeticBrowseCommand::getArguments() — Method in class AlphabeticBrowseCommand

Return search backend interface method arguments.

AlphabeticBrowseCommand::getSource() — Method in class AlphabeticBrowseCommand

Return name of index to search.

AlphabeticBrowseCommand::getFrom() — Method in class AlphabeticBrowseCommand

Return starting point for browse results.

AlphabeticBrowseCommand::getPage() — Method in class AlphabeticBrowseCommand

Return result page to return.

AlphabeticBrowseCommand::getLimit() — Method in class AlphabeticBrowseCommand

Return number of results to return on each page.

AlphabeticBrowseCommand::getOffsetDelta() — Method in class AlphabeticBrowseCommand

Return delta to use when calculating page offset.

CallMethodCommand::getArguments() — Method in class CallMethodCommand

Return search backend interface method arguments.

CommandInterface::getTargetIdentifier() — Method in class CommandInterface

Return target backend identifier.

CommandInterface::getResult() — Method in class CommandInterface

Return result of executed operation.

CommandInterface::getSearchParameters() — Method in class CommandInterface

Return search parameters.

CommandInterface::getContext() — Method in class CommandInterface

Return command context.

QueryOffsetLimitTrait::getQuery() — Method in class QueryOffsetLimitTrait

Return search query.

QueryOffsetLimitTrait::getOffset() — Method in class QueryOffsetLimitTrait

Return search offset.

QueryOffsetLimitTrait::getLimit() — Method in class QueryOffsetLimitTrait

Return search limit.

RecordIdentifierTrait::getRecordIdentifier() — Method in class RecordIdentifierTrait

Return record identifier.

GetIdsCommandClass in namespace VuFindSearch\Command

Get identifiers of records command.

GetIdsCommand::getArguments() — Method in class GetIdsCommand

Return search backend interface method arguments.

GetLuceneHelperCommandClass in namespace VuFindSearch\Command

Command to fetch a Lucene helper object from a search backend.

GetQueryBuilderCommandClass in namespace VuFindSearch\Command

Command to fetch a query builder object from a backend (if supported).

GetUniqueKeyCommandClass in namespace VuFindSearch\Command

Get the backend's unique search key field (currently only supported by Solr)

RandomCommand::getArguments() — Method in class RandomCommand

Return search backend interface method arguments.

RandomCommand::getQuery() — Method in class RandomCommand

Return search query.

RandomCommand::getLimit() — Method in class RandomCommand

Return search limit.

RetrieveBatchCommand::getArguments() — Method in class RetrieveBatchCommand

Return search backend interface method arguments.

RetrieveBatchCommand::getRecordIdentifiers() — Method in class RetrieveBatchCommand

Return record identifiers.

RetrieveCommand::getArguments() — Method in class RetrieveCommand

Return search backend interface method arguments.

SearchCommand::getArguments() — Method in class SearchCommand

Return search backend interface method arguments.

SetRecordCollectionFactoryCommand::getArguments() — Method in class SetRecordCollectionFactoryCommand

Return search backend interface method arguments.

SetRecordCollectionFactoryCommand::getFactory() — Method in class SetRecordCollectionFactoryCommand

Return factory to set.

SimilarCommand::getArguments() — Method in class SimilarCommand

Return search backend interface method arguments.

TermsCommand::getArguments() — Method in class TermsCommand

Return search backend interface method arguments.

TermsCommand::getField() — Method in class TermsCommand

Return index field.

TermsCommand::getStart() — Method in class TermsCommand

Return starting term.

TermsCommand::getLimit() — Method in class TermsCommand

Return maximum number of terms.

WorkExpressionsCommand::getArguments() — Method in class WorkExpressionsCommand

Return search backend interface method arguments.

WorkExpressionsCommand::getWorkKeys() — Method in class WorkExpressionsCommand

Return work identification keys.

GetIdsInterfaceClass in namespace VuFindSearch\Feature

Optional backend feature: Get identifiers of records.

GetIdsInterface::getIds() — Method in class GetIdsInterface

Perform a search and return record collection of only record identifiers.

Module::getAutoloaderConfig() — Method in class Module

Return autoloader configuration.

ParamBag::get() — Method in class ParamBag

Return parameter value.

ParamBag::getArrayCopy() — Method in class ParamBag

Return copy of parameters as array.

Query::getString() — Method in class Query

Return search string (optionally applying a normalization callback)

Query::getHandler() — Method in class Query

Return name of search handler.

Query::getOperator() — Method in class Query

Return operator (null if n/a).

Query::getAllTerms() — Method in class Query

Get a concatenated list of all query strings within the object.

QueryGroup::getReducedHandler() — Method in class QueryGroup

Return name of reduced handler.

QueryGroup::getQueries() — Method in class QueryGroup

Return group queries.

QueryGroup::getOperator() — Method in class QueryGroup

Return boolean operator.

QueryGroup::getAllTerms() — Method in class QueryGroup

Get a concatenated list of all query strings within the object.

QueryInterface::getAllTerms() — Method in class QueryInterface

Get a concatenated list of all query strings within the object.

AbstractRecordCollection::getRecords() — Method in class AbstractRecordCollection

Return records.

AbstractRecordCollection::getErrors() — Method in class AbstractRecordCollection

Return any errors.

AbstractRecordCollection::getOffset() — Method in class AbstractRecordCollection

Return offset in the total search result set.

AbstractRecordCollection::getSourceIdentifier() — Method in class AbstractRecordCollection

Return the source backend identifier.

RecordCollectionInterface::getTotal() — Method in class RecordCollectionInterface

Return total number of records found.

RecordCollectionInterface::getFacets() — Method in class RecordCollectionInterface

Return available facets.

RecordCollectionInterface::getRecords() — Method in class RecordCollectionInterface

Return records.

RecordCollectionInterface::getErrors() — Method in class RecordCollectionInterface

Return any errors.

RecordCollectionInterface::getOffset() — Method in class RecordCollectionInterface

Return offset in the total search result set.

RecordCollectionInterface::getSourceIdentifier() — Method in class RecordCollectionInterface

Return the source backend identifier.

RecordInterface::getSourceIdentifier() — Method in class RecordInterface

Return the source backend identifier.

RecordInterface::getSearchBackendIdentifier() — Method in class RecordInterface

Return the search backend identifier used to find the record.

RecordInterface::getLabels() — Method in class RecordInterface

Return all labels for the record

RecordTrait::getSourceIdentifier() — Method in class RecordTrait

Return the source backend identifier.

RecordTrait::getSearchBackendIdentifier() — Method in class RecordTrait

Return the search backend identifier used to find the record.

RecordTrait::getLabels() — Method in class RecordTrait

Return all labels for the record

SimpleRecord::get() — Method in class SimpleRecord

Get field contents.

Service::getEventManager() — Method in class Service

Return EventManager instance.

CheckRequestIsValidTest::getHandler() — Method in class CheckRequestIsValidTest

Set up a CheckRequestIsValid handler for testing.

CommentRecordTest::getHandler() — Method in class CommentRecordTest

Set up a CommentRecord handler for testing.

CommentRecordTest::getMockResource() — Method in class CommentRecordTest

Return a mock resource row that expects a specific user and comment.

DoiLookupTest::getMockPlugin() — Method in class DoiLookupTest

Create a mock plugin.

DoiLookupTest::getHandlerResults() — Method in class DoiLookupTest

After setupConfig() and setupPluginManager() have been called, run the standard default test.

DoiLookupTest::getTestSingleLookupData() — Method in class DoiLookupTest

Data provider for testSingleLookup

RecommendTest::getMockParams() — Method in class RecommendTest

Get a mock params object.

RecommendTest::getMockResults() — Method in class RecommendTest

Get a mock results object.

ChoiceAuthTest::getSessionContainer() — Method in class ChoiceAuthTest

Get a dummy session container.

ChoiceAuthTest::getChoiceAuth() — Method in class ChoiceAuthTest

Get a ChoiceAuth object.

ChoiceAuthTest::getMockPluginManager() — Method in class ChoiceAuthTest

Get a mock plugin manager.

ChoiceAuthTest::getMockUser() — Method in class ChoiceAuthTest

Get a mock user object

ChoiceAuthTest::getMockRequest() — Method in class ChoiceAuthTest

Get a mock request object

DatabaseTest::getRequest() — Method in class DatabaseTest

Support method -- turn an array into a request populated for use by the authentication class.

DatabaseTest::getAccountCreationRequest() — Method in class DatabaseTest

Support method -- get parameters to create an account (but allow override of individual parameters so we can test different scenarios).

DatabaseTest::getLoginRequest() — Method in class DatabaseTest

Support method -- get parameters to log into an account (but allow override of individual parameters so we can test different scenarios).

DatabaseUnitTest::getTestCreateWithPasswordPolicyData() — Method in class DatabaseUnitTest

Data provider for testCreateWithPasswordPolicy

DatabaseUnitTest::getTestCreateWithUsernamePolicyData() — Method in class DatabaseUnitTest

Data provider for testCreateWithUsernamePolicy

DatabaseUnitTest::getCreateParams() — Method in class DatabaseUnitTest

Get fake create account parameters.

DatabaseUnitTest::getMockRow() — Method in class DatabaseUnitTest

Get a mock row object

DatabaseUnitTest::getMockTable() — Method in class DatabaseUnitTest

Get a mock table object

DatabaseUnitTest::getRequest() — Method in class DatabaseUnitTest

Get a fake HTTP request.

DatabaseUnitTest::getDatabase() — Method in class DatabaseUnitTest

Get a handler w/ fake table manager.

ILSAuthenticatorTest::getAuthenticator() — Method in class ILSAuthenticatorTest

Get an authenticator

ILSAuthenticatorTest::getMockUser() — Method in class ILSAuthenticatorTest

Get a mock user object

ILSAuthenticatorTest::getMockManager() — Method in class ILSAuthenticatorTest

Get a mock auth manager

ILSAuthenticatorTest::getMockConnection() — Method in class ILSAuthenticatorTest

Get a mock ILS connection

ILSTest::getMockDriver() — Method in class ILSTest

Get a mock ILS driver to test.

ILSTest::getAuth() — Method in class ILSTest

Get the object to test.

ILSTest::getLoginRequest() — Method in class ILSTest

Support method -- get parameters to log into an account (but allow override of individual parameters so we can test different scenarios).

ILSTest::getMockILSAuthenticator() — Method in class ILSTest

Get mock ILS authenticator

LDAPTest::getAuthObject() — Method in class LDAPTest

Get an authentication object.

LDAPTest::getAuthConfig() — Method in class LDAPTest

Get a working configuration for the LDAP object

LDAPTest::getLoginRequest() — Method in class LDAPTest

Support method -- get parameters to log into an account (but allow override of individual parameters so we can test different scenarios).

ManagerTest::getManager() — Method in class ManagerTest

Get a manager object to test with.

ManagerTest::getMockUserTable() — Method in class ManagerTest

Get a mock user table.

ManagerTest::getMockSessionManager() — Method in class ManagerTest

Get a mock session manager.

ManagerTest::getMockPluginManager() — Method in class ManagerTest

Get a mock plugin manager.

ManagerTest::getMockUser() — Method in class ManagerTest

Get a mock user object

ManagerTest::getMockRequest() — Method in class ManagerTest

Get a mock request object

MultiAuthTest::getAuthObject() — Method in class MultiAuthTest

Get an authentication object.

MultiAuthTest::getAuthConfig() — Method in class MultiAuthTest

Get a working configuration for the auth object

MultiAuthTest::getLoginRequest() — Method in class MultiAuthTest

Support method -- get parameters to log into an account (but allow override of individual parameters so we can test different scenarios).

MultiILSTest::getLoginRequest() — Method in class MultiILSTest

Support method -- get parameters to log into an account (but allow override of individual parameters so we can test different scenarios).

MultiILSTest::getMockILSAuthenticator() — Method in class MultiILSTest

Get mock ILS authenticator

MultiILSTest::getMockMultiBackend() — Method in class MultiILSTest

Get a mock MultiBackend driver to test.

MultiILSTest::getMultiILS() — Method in class MultiILSTest

Get the object to test.

SIP2Test::getAuthObject() — Method in class SIP2Test

Get an authentication object.

SIP2Test::getAuthConfig() — Method in class SIP2Test

Get a working configuration for the LDAP object

SIP2Test::getLoginRequest() — Method in class SIP2Test

Support method -- get parameters to log into an account (but allow override of individual parameters so we can test different scenarios).

ShibbolethTest::getAuthObject() — Method in class ShibbolethTest

Get an authentication object.

ShibbolethTest::getAuthConfig() — Method in class ShibbolethTest

Get a working configuration for the Shibboleth object

ShibbolethTest::getShibbolethConfig() — Method in class ShibbolethTest

Get a working configuration for the Shibboleth object

ShibbolethTest::getLoginRequest() — Method in class ShibbolethTest

Support method -- get parameters to log into an account (but allow override of individual parameters so we can test different scenarios).

EdsTest::getMockBackend() — Method in class EdsTest

Get a mock backend

EdsTest::getMockBackendManager() — Method in class EdsTest

Wrap a mock backend in a backend manager

SolrTest::getMockOptions() — Method in class SolrTest

Get mock search options.

SolrTest::getMockResults() — Method in class SolrTest

Get mock results plugin manager.

SolrTest::getMockResultsPluginManager() — Method in class SolrTest

Get mock results plugin manager.

BackendTest::getSearchTestData() — Method in class BackendTest

Data provider for testSearch

BackendTest::getInvalidBlockSizes() — Method in class BackendTest

Data provider for testInvalidAdaptiveBlockSize

BackendTest::getBackendForFacetsAndErrors() — Method in class BackendTest

Create a backend that returns the given values for facets and errors

BackendTest::getSearchParams() — Method in class BackendTest

Return search params

BackendTest::getBackend() — Method in class BackendTest

Return Blender backend.

BackendTest::getSolrConnector() — Method in class BackendTest

Return Solr connector mock.

BackendTest::getSolrBackend() — Method in class BackendTest

Return Solr backend.

BackendTest::getEDSBackendMock() — Method in class BackendTest

Return EDS backend mock.

BackendTest::getSolrRecordCollectionFactory() — Method in class BackendTest

Return Solr record collection factory.

BackendTest::getEDSRecordCollectionFactory() — Method in class BackendTest

Return EDS record collection factory.

BackendTest::getConnector() — Method in class BackendTest

Return connector.

BackendTest::getConnectorMock() — Method in class BackendTest

Return connector mock.

BackendTest::getRCFactory() — Method in class BackendTest

Build a real record collection factory

BackendTest::getConnectorMock() — Method in class BackendTest

Return connector mock.

BackendTest::getBackend() — Method in class BackendTest

Return backend

BackendTest::getRCFactory() — Method in class BackendTest

Build a real record collection factory

GetInfoCommandTestClass in namespace VuFindTest\Backend\EDS\Command

Unit tests for GetInfoCommand.

BackendTest::getConnectorMock() — Method in class BackendTest

Return connector mock.

BackendTest::getRCFactory() — Method in class BackendTest

Build a real record collection factory

BackendTest::getConnector() — Method in class BackendTest

Return connector.

BackendTest::getConnectorMock() — Method in class BackendTest

Return connector mock.

BackendTest::getRCFactory() — Method in class BackendTest

Build a real record collection factory

BackendTest::getConnectorMock() — Method in class BackendTest

Return connector mock.

BackendTest::getStatXml() — Method in class BackendTest

Get a fake stat response.

BackendTest::getPcAvailabilityData() — Method in class BackendTest

Data provider for testPcAvailabilityFilter

BackendTest::getConnectorMock() — Method in class BackendTest

Return connector mock.

BackendTest::getConnectorMock() — Method in class BackendTest

Return connector mock.

ConnectorTest::getConnectorMock() — Method in class ConnectorTest

Return connector mock.

QueryBuilderTest::getQuestionTests() — Method in class QueryBuilderTest

Return array of [test query, expected result] arrays.

QueryBuilderTest::globalExtraParamsIndividualQueryDataProvider() — Method in class QueryBuilderTest

Data provider for testIndividualQueryHandlerWithGlobalExtraParams().

QueryBuilderTest::globalExtraParamsGroupedQueryDataProvider() — Method in class QueryBuilderTest

Data provider for testGroupedQueryHandlerWithGlobalExtraParams().

BackendTest::getConnectorMock() — Method in class BackendTest

Return connector mock.

GetHoldingsCommandTestClass in namespace VuFindTest\Backend\WorldCat\Command

Unit tests for GetHoldingsCommand.

ImporterTest::getImporter() — Method in class ImporterTest

Get an Importer configured for testing.

CartTest::getMockCookieManager() — Method in class CartTest

Build a mock cookie manager.

CartTest::getCart() — Method in class CartTest

Build a mock cart object.

AlphaBrowseTest::getCommandChecker() — Method in class AlphaBrowseTest

Support method to test callbacks.

AlphaBrowseTest::getDriver() — Method in class AlphaBrowseTest

Get a fake record driver

AlphaBrowseTest::getAlphaBrowse() — Method in class AlphaBrowseTest

Get AlphaBrowse object

RandomTest::getConfiguredCoverRouterMock() — Method in class RandomTest

Get a configured cover router mock.

RandomTest::getConfiguredRecordRouterMock() — Method in class RandomTest

Get a configured record router mock.

RandomTest::getCommandChecker() — Method in class RandomTest

Support method to test callbacks.

RandomTest::getConfiguredParamsMock() — Method in class RandomTest

Get a configured parameters object mock.

RandomTest::getDriver() — Method in class RandomTest

Get a fake record driver

SimilarItemsTest::getSimilarItems() — Method in class SimilarItemsTest

Get SimilarItems mock object

SimilarItemsTest::getCommandChecker() — Method in class SimilarItemsTest

Support method to test callbacks.

SimilarItemsTest::getDriver() — Method in class SimilarItemsTest

Get a fake record driver

ThemeCommandTest::getMockCompiler() — Method in class ThemeCommandTest

Get a mock compiler object

DynamicRouteCommandTest::getMockGeneratorTools() — Method in class DynamicRouteCommandTest

Get a mock generator tools object

DynamicRouteCommandTest::getMockRouteGenerator() — Method in class DynamicRouteCommandTest

Get a mock container object

ExtendClassCommandTest::getMockGeneratorTools() — Method in class ExtendClassCommandTest

Get a mock generator tools object

ExtendClassCommandTest::getMockContainer() — Method in class ExtendClassCommandTest

Get a mock container object

ExtendServiceCommandTest::getMockGeneratorTools() — Method in class ExtendServiceCommandTest

Get a mock generator tools object

NonTabRecordActionCommandTest::getMockGeneratorTools() — Method in class NonTabRecordActionCommandTest

Get a mock generator tools object

PluginCommandTest::getMockGeneratorTools() — Method in class PluginCommandTest

Get a mock generator tools object

PluginCommandTest::getMockContainer() — Method in class PluginCommandTest

Get a mock container object

RecordRouteCommandTest::getMockGeneratorTools() — Method in class RecordRouteCommandTest

Get a mock generator tools object

RecordRouteCommandTest::getMockRouteGenerator() — Method in class RecordRouteCommandTest

Get a mock container object

StaticRouteCommandTest::getMockGeneratorTools() — Method in class StaticRouteCommandTest

Get a mock generator tools object

StaticRouteCommandTest::getMockRouteGenerator() — Method in class StaticRouteCommandTest

Get a mock container object

ThemeCommandTest::getMockGenerator() — Method in class ThemeCommandTest

Create a mock generator object.

ThemeMixinCommandTest::getMockGenerator() — Method in class ThemeMixinCommandTest

Create a mock generator object.

GetIdsCommandTestClass in namespace VuFindTest\Command

Unit tests for GetIdsCommand.

GetLuceneHelperCommandTestClass in namespace VuFindTest\Command

Unit tests for GetLuceneHelperCommand.

GetQueryBuilderCommandTestClass in namespace VuFindTest\Command

Unit tests for GetQueryBuilderCommand.

GetUniqueKeyCommandTestClass in namespace VuFindTest\Command

Unit tests for GetUniqueKeyCommand.

ImportCsvCommandTest::getMockImporter() — Method in class ImportCsvCommandTest

Get a mock importer object

ImportXslCommandTest::getMockImporter() — Method in class ImportXslCommandTest

Get a mock importer object

InstallCommandTest::getMockCommand() — Method in class InstallCommandTest

Get a mock command object

WebCrawlCommandTest::getMockCommand() — Method in class WebCrawlCommandTest

Get a mock command object

WebCrawlCommandTest::getMockImporter() — Method in class WebCrawlCommandTest

Get a mock importer object

WebCrawlCommandTest::getMockSolrWriter() — Method in class WebCrawlCommandTest

Get a mock solr writer object

AddUsingTemplateCommandTest::getMockCommand() — Method in class AddUsingTemplateCommandTest

Get a mock command object

AddUsingTemplateCommandTest::getMockNormalizer() — Method in class AddUsingTemplateCommandTest

Get a mock normalizer object

AddUsingTemplateCommandTest::getMockReader() — Method in class AddUsingTemplateCommandTest

Get a mock reader object

CopyStringCommandTest::getSuccessfulMockCommand() — Method in class CopyStringCommandTest

Get a command mock with expectations of success.

CopyStringCommandTest::getMockCommand() — Method in class CopyStringCommandTest

Get a mock command object

CopyStringCommandTest::getMockNormalizer() — Method in class CopyStringCommandTest

Get a mock normalizer object

CopyStringCommandTest::getMockReader() — Method in class CopyStringCommandTest

Get a mock reader object

DeleteCommandTest::getMockCommand() — Method in class DeleteCommandTest

Get a mock command object

DeleteCommandTest::getMockNormalizer() — Method in class DeleteCommandTest

Get a mock normalizer object

DeleteCommandTest::getMockReader() — Method in class DeleteCommandTest

Get a mock reader object

NormalizeCommandTest::getMockNormalizer() — Method in class NormalizeCommandTest

Get a mock normalizer object

NormalizeCommandTest::getMockReader() — Method in class NormalizeCommandTest

Get a mock reader object

NotifyCommandTest::getMockSearchResultsSet() — Method in class NotifyCommandTest

Get mock search results.

NotifyCommandTest::getMockNotifications() — Method in class NotifyCommandTest

Create a list of fake notification objects.

NotifyCommandTest::getMockSearchResults() — Method in class NotifyCommandTest

Get mock search results.

NotifyCommandTest::getMockSearch() — Method in class NotifyCommandTest

Get a minified search object

NotifyCommandTest::getMockUserObject() — Method in class NotifyCommandTest

Get a mock row representing a user.

NotifyCommandTest::getCommand() — Method in class NotifyCommandTest

Get a notify command for testing.

NotifyCommandTest::getMockResultsManager() — Method in class NotifyCommandTest

Create a mock results manager.

NotifyCommandTest::getMockSearchTable() — Method in class NotifyCommandTest

Create a mock search table that returns a list of fake notification objects.

NotifyCommandTest::getMockUserTable() — Method in class NotifyCommandTest

Create a mock user table that returns a fake user object.

SearchCommandTest::getCommand() — Method in class SearchCommandTest

Get test SearchCommand Object

SimilarCommandTest::getCommand() — Method in class SimilarCommandTest

Get test SimilarCommand Object

SimilarCommandTest::getBackend() — Method in class SimilarCommandTest

Get test backend Object

AbstractExpireCommandTest::getCommand() — Method in class AbstractExpireCommandTest

Get the command class

CreateHierarchyTreesCommandTest::getMockHierarchyDriver() — Method in class CreateHierarchyTreesCommandTest

Get mock hierarchy driver

CreateHierarchyTreesCommandTest::getMockTreeSource() — Method in class CreateHierarchyTreesCommandTest

Get mock tree source

CreateHierarchyTreesCommandTest::getMockRecord() — Method in class CreateHierarchyTreesCommandTest

Get mock record.

CreateHierarchyTreesCommandTest::getMockRecordLoader() — Method in class CreateHierarchyTreesCommandTest

Get mock record loader.

CreateHierarchyTreesCommandTest::getMockResults() — Method in class CreateHierarchyTreesCommandTest

Get mock results.

CreateHierarchyTreesCommandTest::getMockResultsManager() — Method in class CreateHierarchyTreesCommandTest

Get mock results manager.

CreateHierarchyTreesCommandTest::getCommand() — Method in class CreateHierarchyTreesCommandTest

Get command to test.

DedupeCommandTest::getMockCommand() — Method in class DedupeCommandTest

Get a mocked-out command object.

DeletesCommandTest::getMockWriter() — Method in class DeletesCommandTest

Get mock Solr writer.

IndexReservesCommandTest::getMockIlsConnection() — Method in class IndexReservesCommandTest

Get mock ILS connection.

IndexReservesCommandTest::getMockSolrWriter() — Method in class IndexReservesCommandTest

Get mock Solr writer.

IndexReservesCommandTest::getCommand() — Method in class IndexReservesCommandTest

Get command to test.

SuppressedCommandTest::getMockIlsConnection() — Method in class SuppressedCommandTest

Get mock ILS connection.

SuppressedCommandTest::getMockSolrWriter() — Method in class SuppressedCommandTest

Get mock Solr writer.

SuppressedCommandTest::getCommand() — Method in class SuppressedCommandTest

Get command to test.

SwitchDbHashCommandTest::getMockTable() — Method in class SwitchDbHashCommandTest

Get mock table object

SwitchDbHashCommandTest::getMockCommand() — Method in class SwitchDbHashCommandTest

Get mock command object

SwitchDbHashCommandTest::getMockConfigWriter() — Method in class SwitchDbHashCommandTest

Get a mock config writer

SwitchDbHashCommandTest::getMockUserObject() — Method in class SwitchDbHashCommandTest

Get a mock row representing a user.

PathResolverTest::getTestPathStackData() — Method in class PathResolverTest

Data provider for testPathStack

PathResolverTest::getStackedFixtureDir() — Method in class PathResolverTest

Get path to stacked config fixtures

PluginFactoryTest::getConfig() — Method in class PluginFactoryTest

Wrapper around factory

UpgradeTest::getUpgrader() — Method in class UpgradeTest

Get an upgrade object for the specified source version:

WikipediaTest::getClient() — Method in class WikipediaTest

Load HTTP client w/ fixture

WorldCatUtilsTest::getClient() — Method in class WorldCatUtilsTest

Load WorldCatUtils client w/ fixture

MockContainerTrait::get() — Method in class MockContainerTrait

Finds an entry of the container by its identifier and returns it.

BokinfoTest::getMockRequest() — Method in class BokinfoTest

Get mock request/headers to expect key setting.

BokinfoTest::getMockResponse() — Method in class BokinfoTest

Get mock response object

BokinfoTest::getMockClient() — Method in class BokinfoTest

Get a mock HTTP client.

BokinfoTest::getMockService() — Method in class BokinfoTest

Get a mock HTTP service to support testValidCoverLoading().

DeprecatedTest::getUrl() — Method in class DeprecatedTest

Simulate retrieval of a cover URL for a particular size.

InstallControllerTest::getMinimalPhpVersionProvider() — Method in class InstallControllerTest

getMinimalPhpVersion test data

InstallControllerTest::getMinimalPhpVersionMethod() — Method in class InstallControllerTest

Return method InstallController::getMinimalPhpVersion

LanguageHelperTest::getMockHelper() — Method in class LanguageHelperTest

Get a mock controller.

FollowupTest::getMockController() — Method in class FollowupTest

Get a mock controller

MockILSConnection::getFunds() — Method in class MockILSConnection
MockILSConnection::getNewItems() — Method in class MockILSConnection
NewItemsTest::getMockCatalog() — Method in class NewItemsTest

Get a mock catalog object (for use in getBibIDs tests).

NewItemsTest::getMockParams() — Method in class NewItemsTest

Get a mock params object.

ResultScrollerTest::getFirstLastConfig() — Method in class ResultScrollerTest

Get a configuration array to turn on first/last setting.

ResultScrollerTest::getMockResults() — Method in class ResultScrollerTest

Get mock search results

ResultScrollerTest::getMockResultScroller() — Method in class ResultScrollerTest

Get mock result scroller

LoaderTest::getLoader() — Method in class LoaderTest

Get a loader object to test.

LoaderTest::getThemeDir() — Method in class LoaderTest

Get the theme directory.

RouterTest::getDriver() — Method in class RouterTest

Get a fake record driver

RouterTest::getRouter() — Method in class RouterTest

Get a router to test

RouterTest::getCoverLoader() — Method in class RouterTest

Get a loader object to test.

RouterTest::getThemeDir() — Method in class RouterTest

Get the theme directory.

UserListTest::getMockTable() — Method in class UserListTest

Get a mock table object.

UserListTest::getMockUser() — Method in class UserListTest

Create a mock user object.

BrowZineTest::getBackendManager() — Method in class BrowZineTest

Given a connector, wrap it up in a backend and backend manager

BrowZineTest::getMockConnector() — Method in class BrowZineTest

Get a mock connector

ExportTest::getFakeMARCXML() — Method in class ExportTest

Get a fake MARCXML record

ExportTest::getExport() — Method in class ExportTest

Get a configured Export object.

ConfigPluginManagerTrait::getMockConfigPluginManager() — Method in class ConfigPluginManagerTrait

Get a mock configuration plugin manager with the given configuration "files" available.

ConfigPluginManagerTrait::getMockFailingConfigPluginManager() — Method in class ConfigPluginManagerTrait

Get a mock configuration plugin manager that will throw an exception.

DemoDriverTestTrait::getFakeTransactions() — Method in class DemoDriverTestTrait

Get transaction JSON for Demo.ini.

DemoDriverTestTrait::getDemoIniOverrides() — Method in class DemoDriverTestTrait

Get Demo.ini override settings for testing ILS functions.

DemoDriverTestTrait::getFakeItem() — Method in class DemoDriverTestTrait

Get a fake item record for inclusion in the Demo driver configuration.

FixtureTrait::getFixtureDir() — Method in class FixtureTrait

Get the base directory containing fixtures.

FixtureTrait::getFixturePath() — Method in class FixtureTrait

Resolve fixture path.

FixtureTrait::getFixture() — Method in class FixtureTrait

Load a fixture file.

FixtureTrait::getJsonFixture() — Method in class FixtureTrait

Load a JSON fixture from file (using associative array return type).

LiveDatabaseTrait::getLiveTableManager() — Method in class LiveDatabaseTrait

Get a real, working table manager.

LiveDatabaseTrait::getTable() — Method in class LiveDatabaseTrait

Get a table object.

LiveSolrTrait::getLiveSolrContainer() — Method in class LiveSolrTrait

Get container for services related to live Solr connectivity.

LiveSolrTrait::getBackend() — Method in class LiveSolrTrait

Get a search backend

LiveSolrTrait::getResultsObject() — Method in class LiveSolrTrait

Get a search results object

MockSearchCommandTrait::getMockSearchCommand() — Method in class MockSearchCommandTrait

Get a mock search command.

PathResolverTrait::getPathResolver() — Method in class PathResolverTrait

Get a config file path resolver

ReflectionTrait::getProperty() — Method in class ReflectionTrait

Return protected or private property.

SearchServiceTrait::getSearchService() — Method in class SearchServiceTrait

Create a search service to wrap the provided BackendManager instance

SolrSearchObjectTrait::getMockConfigManager() — Method in class SolrSearchObjectTrait

Get mock config manager.

SolrSearchObjectTrait::getSolrOptions() — Method in class SolrSearchObjectTrait

Get Solr options.

SolrSearchObjectTrait::getSolrParams() — Method in class SolrSearchObjectTrait

Get Solr params.

SolrSearchObjectTrait::getSolrResults() — Method in class SolrSearchObjectTrait

Get Solr results.

TranslatorTrait::getMockTranslator() — Method in class TranslatorTrait

Get mock translator.

ViewTrait::getPhpRenderer() — Method in class ViewTrait

Get a working renderer.

ViewTrait::getPathForTheme() — Method in class ViewTrait

Get the directory for a given theme.

FormTest::getMockTestFormYamlReader() — Method in class FormTest

Get a mock YamlReader object.

FormTest::getMockTestForm() — Method in class FormTest

Get a mock Form object.

FormTest::getEmailSubjectsData() — Method in class FormTest

Function to get testEmailSubjects data.

EmailTest::getHandler() — Method in class EmailTest

Get a handler configured for testing.

FacetFormatterTest::getFakeFacetData() — Method in class FacetFormatterTest

Get fake facet data.

FacetFormatterTest::getFakeHierarchicalFacetData() — Method in class FacetFormatterTest

Get fake hierarchical facet data.

FacetFormatterTest::getFakeResults() — Method in class FacetFormatterTest

Get fake results object.

RecordFormatterTest::getDefaultDefs() — Method in class RecordFormatterTest

Get default configuration to use in tests when no overrides are specified.

RecordFormatterTest::getHelperPluginManager() — Method in class RecordFormatterTest

Get a helper plugin manager for the RecordFormatter.

RecordFormatterTest::getFormatter() — Method in class RecordFormatterTest

Get a formatter to test with.

RecordFormatterTest::getDriver() — Method in class RecordFormatterTest

Get a record driver to test with.

LocaleDetectorFactoryTest::getStrategyClasses() — Method in class LocaleDetectorFactoryTest

Call getStrategies on a LocaleDetectorFactory and return a list of classes constructed as a result.

SorterTest::getSorterForTest() — Method in class SorterTest

Get sorter for current test

DummyILS::getStatus() — Method in class DummyILS

Get Status

DummyILS::getStatuses() — Method in class DummyILS

Get Statuses

DummyILS::getHolding() — Method in class DummyILS

Get Holding

DummyILS::getPurchaseHistory() — Method in class DummyILS

Get Purchase History

GeniePlusTestClass in namespace VuFindTest\ILS\Driver

GeniePlus ILS driver test

GeniePlusTest::getMockResponse() — Method in class GeniePlusTest

Get a mock response with a predetermined body.

ILSMockTrait::getCancelHoldDetails() — Method in class ILSMockTrait
ILSMockTrait::getCancelILLRequestDetails() — Method in class ILSMockTrait
ILSMockTrait::getCancelStorageRetrievalRequestDetails() — Method in class ILSMockTrait
ILSMockTrait::getConfig() — Method in class ILSMockTrait
ILSMockTrait::getDefaultPickUpLocation() — Method in class ILSMockTrait
ILSMockTrait::getDefaultRequestGroup() — Method in class ILSMockTrait
ILSMockTrait::getMyILLRequests() — Method in class ILSMockTrait
ILSMockTrait::getILLPickUpLibraries() — Method in class ILSMockTrait
ILSMockTrait::getILLPickUpLocations() — Method in class ILSMockTrait
ILSMockTrait::getPickUpLocations() — Method in class ILSMockTrait
ILSMockTrait::getRenewDetails() — Method in class ILSMockTrait
ILSMockTrait::getRequestGroups() — Method in class ILSMockTrait
ILSMockTrait::getAccountBlocks() — Method in class ILSMockTrait
ILSMockTrait::getRequestBlocks() — Method in class ILSMockTrait
MultiBackendTest::getDriver() — Method in class MultiBackendTest

Method to get a fresh MultiBackend Driver.

MultiBackendTest::getMultibackendForDrivers() — Method in class MultiBackendTest

Create a MultiBackend driver for the given ILS drivers

MultiBackendTest::getMockILSAuthenticator() — Method in class MultiBackendTest

Get a mock ILS authenticator

MultiBackendTest::getPatron() — Method in class MultiBackendTest

Method to get a patron with the given username

MultiBackendTest::getMockSM() — Method in class MultiBackendTest

This function returns a mock service manager with the given parameters For examples of what is to be passed, see: http://www.phpunit.de/manual/3.0/en/mock-objects.html

MultiBackendTest::getMockDemoDriver() — Method in class MultiBackendTest

Get a mock Demo driver

MultiBackendTest::getMockILS() — Method in class MultiBackendTest

Get a mock driver

PAIATest::getHttpService() — Method in class PAIATest

Create HTTP service for testing.

MinkTestCase::getDefaultTimeout() — Method in class MinkTestCase

Get the default timeout in milliseconds

MinkTestCase::getMinkDriver() — Method in class MinkTestCase

Get the Mink driver, initializing it if necessary.

MinkTestCase::getMinkSession() — Method in class MinkTestCase

Get a Mink session.

MinkTestCase::getVuFindUrl() — Method in class MinkTestCase

Get base URL of running VuFind instance.

MinkTestCase::getCurrentQueryString() — Method in class MinkTestCase

Get query string for the current page

ResultFeedTest::getPlugins() — Method in class ResultFeedTest

Get plugins to register to support view helper being tested

ResultFeedTest::getMockTranslator() — Method in class ResultFeedTest

Mock out the translator.

FakeDriverTrait::getDriver() — Method in class FakeDriverTrait

Get a fake record driver

AccountMenuTest::getJSStorage() — Method in class AccountMenuTest

Get associative array of storage state

AdvancedSearchTest::goToAdvancedSearch() — Method in class AdvancedSearchTest

Go to the advanced search page.

BlendedSearchTest::getBlenderIniOverrides() — Method in class BlendedSearchTest

Get config settings for Blender.ini.

BlendedSearchTest::getSearchData() — Method in class BlendedSearchTest

Data provider for testSearch

BulkTest::getSearchResultsPage() — Method in class BulkTest

Get a reference to a standard search results page.

CartTest::getSearchResultsPage() — Method in class CartTest

Get a reference to a standard search results page.

CartTest::getRecordPage() — Method in class CartTest

Get a reference to a standard search results page.

CartTest::getSearchHistory() — Method in class CartTest

Get the search history data.

ChannelsTest::getChannelsPage() — Method in class ChannelsTest

Get a reference to a standard search results page.

ChoiceAuthTest::getConfigIniOverrides() — Method in class ChoiceAuthTest

Get config.ini override settings for testing ChoiceAuth.

ChoiceAuthTest::getDemoIniOverrides() — Method in class ChoiceAuthTest

Get Demo.ini override settings for testing ILS functions.

CombinedSearchTest::getCombinedIniOverrides() — Method in class CombinedSearchTest

Get config settings for combined.ini.

CookieConsentTest::getStartPage() — Method in class CookieConsentTest

Get start page

FavoritesTest::gotoSearch() — Method in class FavoritesTest

Perform a search and return the page after submitting the form.

FavoritesTest::gotoRecord() — Method in class FavoritesTest

Perform a search and return the page after submitting the form and clicking the first record.

FavoritesTest::gotoUserAccount() — Method in class FavoritesTest

Login and go to account home

FeedbackTest::getConfigIniOverrides() — Method in class FeedbackTest

Get config.ini override settings for testing feedback.

HoldsTest::getConfigIniOverrides() — Method in class HoldsTest

Get config.ini override settings for testing ILS functions.

HoldsTest::gotoRecordById() — Method in class HoldsTest

Move the current page to a record by performing a search.

IlsActionsTest::getConfigIniOverrides() — Method in class IlsActionsTest

Get config.ini override settings for testing ILS functions.

IlsActionsTest::gotoRecordById() — Method in class IlsActionsTest

Move the current page to a record by performing a search.

LinkResolverTest::getConfigIniOverrides() — Method in class LinkResolverTest

Get config.ini override settings for testing ILS functions.

ListViewsTest::gotoSearch() — Method in class ListViewsTest

Perform a search and return the page after submitting the form.

ListViewsTest::gotoRecord() — Method in class ListViewsTest

Perform a search and return the page after submitting the form and clicking the first record.

OAuth2Test::getConfigIniOverrides() — Method in class OAuth2Test

Get config.ini override settings for testing ILS functions.

OAuth2Test::getOauth2ConfigOverrides() — Method in class OAuth2Test

Get OAuth2Server.yaml overrides

RecordActionsTest::gotoRecord() — Method in class RecordActionsTest

Move the current page to a record by performing a search.

RecordActionsTest::getTestRatingData() — Method in class RecordActionsTest

Data provider for testRating

SearchFacetsTest::getFilteredSearch() — Method in class SearchFacetsTest

Get filtered search

UserIpReaderFactoryTest::getContainer() — Method in class UserIpReaderFactoryTest

Get a container set up for the factory.

ServerTest::getServer() — Method in class ServerTest

Get a server object.

ServerTest::getMockResultsManager() — Method in class ServerTest

Get a mock results manager

ServerTest::getMockRecordLoader() — Method in class ServerTest

Get a mock record loader

ServerTest::getMockTableManager() — Method in class ServerTest

Get a mock table manager

ServerTest::getMockRecordFormatter() — Method in class ServerTest

Get a mock record formatter

AbstractTokenRepositoryTest::getMockAccessTokenTable() — Method in class AbstractTokenRepositoryTest

Create AccessToken table

IdentityRepositoryTest::getTestIdentityRepositoryData() — Method in class IdentityRepositoryTest

Data provider for testIdentityRepository

IdentityRepositoryTest::getMockUser() — Method in class IdentityRepositoryTest

Get a mock user object

IdentityRepositoryTest::getMockUserTable() — Method in class IdentityRepositoryTest

Create a mock user table that returns a fake user object.

IdentityRepositoryTest::getMockIlsConnection() — Method in class IdentityRepositoryTest

Get mock ILS connection.

IdentityRepositoryTest::getMockFailingIlsConnection() — Method in class IdentityRepositoryTest

Get mock ILS connection that throws an exception for any actual ILS request.

IdentityRepositoryTest::getCatUsernameHash() — Method in class IdentityRepositoryTest

Create a hash from a user name

ScopeRepositoryTest::getTestScopeRepositoryData() — Method in class ScopeRepositoryTest

Data provider for testScopeRepository

LoaderTest::getLoader() — Method in class LoaderTest

Get a loader object to test.

LoaderTest::getThemeDir() — Method in class LoaderTest

Get the theme directory.

QueryGroupTest::getSampleQueryGroup() — Method in class QueryGroupTest

Get a test object.

QueryGroupTest::getSampleQueryGroupWithWeirdCharacters() — Method in class QueryGroupTest

Get a test object with uppercase and accents.

CollectionSideFacetsTest::getSideFacets() — Method in class CollectionSideFacetsTest

Get a fully configured module

CollectionSideFacetsTest::getMockParams() — Method in class CollectionSideFacetsTest

Get a mock params object.

DOITest::getDOI() — Method in class DOITest

Get a fully configured module

DOITest::getMockResults() — Method in class DOITest

Get a mock results object.

DOITest::getMockParams() — Method in class DOITest

Get a mock params object.

EuropeanaResultsTest::getHttpService() — Method in class EuropeanaResultsTest

Return connector.

EuropeanaResultsTest::getMockResults() — Method in class EuropeanaResultsTest

Get a mock results object.

EuropeanaResultsTest::getMockParams() — Method in class EuropeanaResultsTest

Get a mock params object.

ExpandFacetsTest::getExpandFacets() — Method in class ExpandFacetsTest

Get a fully configured module

ExpandFacetsTest::getMockResults() — Method in class ExpandFacetsTest

Get a mock results object.

ExpandFacetsTest::getMockParams() — Method in class ExpandFacetsTest

Get a mock params object.

FacetCloudTest::getFacetCloud() — Method in class FacetCloudTest

Get a fully configured module

FacetCloudTest::getMockResults() — Method in class FacetCloudTest

Get a mock results object.

FacetCloudTest::getMockParams() — Method in class FacetCloudTest

Get a mock params object.

FavoriteFacetsTest::getFavoriteFacets() — Method in class FavoriteFacetsTest

Get a fully configured module

FavoriteFacetsTest::getMockResults() — Method in class FavoriteFacetsTest

Get a mock results object.

FavoriteFacetsTest::getMockParams() — Method in class FavoriteFacetsTest

Get a mock params object.

MapSelectionTest::getMockSearchService() — Method in class MapSelectionTest

Get a mock search service.

MapSelectionTest::getMapSelection() — Method in class MapSelectionTest

Get the class to test.

SideFacetsTest::getSideFacets() — Method in class SideFacetsTest

Get a fully configured module

SideFacetsTest::getMockResults() — Method in class SideFacetsTest

Get a mock results object.

SideFacetsTest::getMockParams() — Method in class SideFacetsTest

Get a mock params object.

SwitchQueryTest::getSwitchQuery() — Method in class SwitchQueryTest

Get a fully configured module

SwitchQueryTest::getMockBackendManager() — Method in class SwitchQueryTest

Get a mock backend manager.

SwitchQueryTest::getMockResults() — Method in class SwitchQueryTest

Get a mock results object.

SwitchQueryTest::getMockParams() — Method in class SwitchQueryTest

Get a mock params object.

DefaultRecordTest::getDriver() — Method in class DefaultRecordTest

Get a record driver with fake data.

EDSTest::getLinkUrlsProvider() — Method in class EDSTest

Data provider for testLinkUrls

EDSTest::getDriverWithIdentifierData() — Method in class EDSTest

Get a record driver with fake identifier data.

EDSTest::getDriver() — Method in class EDSTest

Get a record driver with fake data.

EITTest::getDriver() — Method in class EITTest

Get a record driver with fake data.

MarcAdvancedTraitTest::getMockDriverFromFixture() — Method in class MarcAdvancedTraitTest

Get a mock record driver from a MARC fixture.

SolrDefaultTest::getDriver() — Method in class SolrDefaultTest

Get a record driver with fake data.

SolrMarcRemoteTest::getDriver() — Method in class SolrMarcRemoteTest

Get a SolrMarcRemote driver preconfigured to load a record.

SolrMarcRemoteTest::getMockHttpService() — Method in class SolrMarcRemoteTest

Get a mock HttpService for testing

SolrOverdriveTest::getDriver() — Method in class SolrOverdriveTest

Get a record driver to test with.

SolrOverdriveTest::getMockConnector() — Method in class SolrOverdriveTest

Get a mock Overdrive connector.

TestHarness::getBreadcrumb() — Method in class TestHarness

Get text that can be displayed to represent this record in breadcrumbs.

TestHarness::getUniqueID() — Method in class TestHarness

Return the unique identifier of this record for retrieving additional information (like tags and user comments) from the external MySQL database.

TestHarness::getSourceIdentifier() — Method in class TestHarness

Return the source backend identifier.

ComponentPartsTest::getService() — Method in class ComponentPartsTest

get a Service object

FormatsTest::getFormats() — Method in class FormatsTest

Get a configured Formats object.

HoldingsWorldCatTest::getService() — Method in class HoldingsWorldCatTest

get a Service object

MapTest::getMap() — Method in class MapTest

get a Map object

PreviewTest::getPreview() — Method in class PreviewTest

Get a configured Preview object.

TabManagerTest::getTabManager() — Method in class TabManagerTest

Set up a tab manager for testing.

TabManagerTest::getMockPluginManager() — Method in class TabManagerTest

Build a mock plugin manager.

VersionsTest::getMockPluginManager() — Method in class VersionsTest

Build a mock plugin manager.

VersionsTest::getMockConfig() — Method in class VersionsTest

Build a mock Config.

CacheTest::getConfig() — Method in class CacheTest

Create configuration

CacheTest::getRecordTable() — Method in class CacheTest

Create Record Table

CacheTest::getRecordFactoryManager() — Method in class CacheTest

Create a Record Factory Manager

CacheTest::getRecordCache() — Method in class CacheTest

Create a Cache object

CacheTest::getDriver() — Method in class CacheTest

Create a record driver

LoaderTest::getCommandChecker() — Method in class LoaderTest

Support method to test callbacks.

LoaderTest::getDriver() — Method in class LoaderTest

Get test record driver object

LoaderTest::getLoader() — Method in class LoaderTest

Build a loader to test.

LoaderTest::getFallbackLoader() — Method in class LoaderTest

Get a fallback loader (currently assumes Summon plugin will be used).

LoaderTest::getCollection() — Method in class LoaderTest

Get a fake record collection.

RouterTest::getDriver() — Method in class RouterTest

Get test record driver object

RouterTest::getRouter() — Method in class RouterTest

Get test router object

BookplateTest::getBookplate() — Method in class BookplateTest

Get the test subject.

BookplateTest::getContainer() — Method in class BookplateTest

Get the mock container.

BookplateTest::getTestRecord() — Method in class BookplateTest

Get a record driver to test with.

CsvReaderTest::getReader() — Method in class CsvReaderTest

Get a reader object with the fixture loaded.

DynamicRoleProviderTest::getDynamicRoleProvider() — Method in class DynamicRoleProviderTest

Get the DynamicRoleProvider to test.

DynamicRoleProviderTest::getFakePluginManager() — Method in class DynamicRoleProviderTest

Get a plugin manager populated with fake services to test.

IpRangeTest::getPermissionProvider() — Method in class IpRangeTest

Get a permission provider with the specified IP assigned.

IpRegExTest::getPermissionProvider() — Method in class IpRegExTest

Get a permission provider with the specified IP assigned.

UserTest::getMockAuthorizationService() — Method in class UserTest

Get a mock authorization service object

UserTest::getMockUser() — Method in class UserTest

Get a mock user object

ClickatellTest::getClickatell() — Method in class ClickatellTest

Build a test object

ClickatellTest::getDefaultConfig() — Method in class ClickatellTest

Get default configuration

ClickatellTest::getMockClient() — Method in class ClickatellTest

Get a mock HTTP client

SearchServiceTest::getBackend() — Method in class SearchServiceTest

Get a mock backend.

SearchServiceTest::getService() — Method in class SearchServiceTest

Generate a fake service.

HideFacetValueListenerTest::getMockBackend() — Method in class HideFacetValueListenerTest

Get a mock backend

HideFacetValueListenerTest::getFacets() — Method in class HideFacetValueListenerTest

Get a facet array for testing.

HideFacetValueListenerTest::getMockResult() — Method in class HideFacetValueListenerTest

Construct a mock Solr result object.

HideFacetValueListenerTest::getListener() — Method in class HideFacetValueListenerTest

Construct a listener for testing.

ParamsTest::getMockOptions() — Method in class ParamsTest

Get mock Options object

ParamsTest::getMockParams() — Method in class ParamsTest

Get mock Params object

ParamsTest::getConfigManager() — Method in class ParamsTest

Get mock config manager

ParamsTest::getParamsClassesArray() — Method in class ParamsTest

Get params classes for an array of backends

ParamsTest::getParams() — Method in class ParamsTest

Get Params class

ResultsTest::getConfigManager() — Method in class ResultsTest

Get mock config manager

ParamsTest::getParams() — Method in class ParamsTest

Get Params object

HistoryTest::getHistory() — Method in class HistoryTest

Get object for testing.

NormalizedSearchTest::getResultsManager() — Method in class NormalizedSearchTest

Get a results manager to test with.

NormalizedSearchTest::getResults() — Method in class NormalizedSearchTest

Get a results object to test with.

NormalizedSearchTest::getNormalizedSearch() — Method in class NormalizedSearchTest

Get a normalized search object to test with.

OnCampusListenerTest::getMockPreEvent() — Method in class OnCampusListenerTest

Construct a mock search backend pre event.

ParamsTest::getParams() — Method in class ParamsTest

Get Params object

SearchTabsHelperTest::getSearchTabsHelper() — Method in class SearchTabsHelperTest

Create a SearchTabsHelper

ConditionalFilterListenerTest::getMockPreEvent() — Method in class ConditionalFilterListenerTest

Construct a mock search backend pre event.

CustomFilterListenerTest::getMockBackend() — Method in class CustomFilterListenerTest

Get a mock backend

CustomFilterListenerTest::getListener() — Method in class CustomFilterListenerTest

Construct a listener for testing.

OptionsTest::getOptions() — Method in class OptionsTest

Get Options object

ParamsTest::getParams() — Method in class ParamsTest

Get Params object

ResultsTest::getSearchServiceWithMockSearchMethod() — Method in class ResultsTest

Get a mock search service that will return a RecordCollection.

ResultsTest::getResults() — Method in class ResultsTest

Get Results object

ResultsTest::getResultsFromResponse() — Method in class ResultsTest

Get a Results objects from a response array.

ResultsTest::getParams() — Method in class ResultsTest

Get Params object

SpellingProcessorTest::getExpectedQuery1Suggestions() — Method in class SpellingProcessorTest

Get expected suggestions for the "query1" example.

SpellingProcessorTest::getExpectedQuery6Suggestions() — Method in class SpellingProcessorTest

Get expected suggestions for the "query6" example.

ParamsTest::getParams() — Method in class ParamsTest

Get Params object

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Results::getFacetList() — Method in class Results

Returns the stored list of facets for the last search

Results::getMockRecordDriver() — Method in class Results

Get a fake record driver

UrlQueryHelperTest::getHelper() — Method in class UrlQueryHelperTest

Get a preconfigured helper.

MarkdownFactoryTest::getMarkdownEnvironmentConfig() — Method in class MarkdownFactoryTest

Return config of created markdown service environment

MarkdownFactoryTest::getMarkdownEnvironmentExtensions() — Method in class MarkdownFactoryTest

Return config of created markdown service environment

MarkdownFactoryTest::getMarkdownConverter() — Method in class MarkdownFactoryTest

Create markdown converter

DatabaseTest::getHandler() — Method in class DatabaseTest

Get the session handler to test.

DatabaseTest::getMockSessionTable() — Method in class DatabaseTest

Get a mock session table.

FileTest::getHandler() — Method in class FileTest

Get the session handler to test.

MemcacheTest::getHandler() — Method in class MemcacheTest

Get the session handler to test.

RedisTest::getHandler() — Method in class RedisTest

Get the session handler to test.

CursorMarkIdFetcherTest::getMockService() — Method in class CursorMarkIdFetcherTest

Get a mock search service

CursorMarkIdFetcherTest::getMockKeyCommand() — Method in class CursorMarkIdFetcherTest

Get a mock "GetUniqueKeyCommand" for testing purposes.

CursorMarkIdFetcherTest::getIdsExpectation() — Method in class CursorMarkIdFetcherTest

Get a function to test that a GetIdsCommand is as expected.

TermsIdFetcherTest::getTermsResponse() — Method in class TermsIdFetcherTest

Get a terms response

TermsIdFetcherTest::getIdsExpectation() — Method in class TermsIdFetcherTest

Get a function to test that a TermsCommand is as expected.

TermsIdFetcherTest::getMockService() — Method in class TermsIdFetcherTest

Get mock search service

TermsIdFetcherTest::getMockTermsCommand() — Method in class TermsIdFetcherTest

Get a mock "TermsCommand" to use as a container for a test value.

TermsIdFetcherTest::getMockKeyCommand() — Method in class TermsIdFetcherTest

Get a mock "GetUniqueKeyCommand" for testing purposes.

GeneratorTestClass in namespace VuFindTest\Sitemap

Sitemap Generator Test Class

GeneratorTest::getGenerator() — Method in class GeneratorTest

Get a generator for testing purposes.

ContentPagesTest::getContentPages() — Method in class ContentPagesTest

Get a ContentPages object from its factory

ContentPagesTest::getMockRouter() — Method in class ContentPagesTest

Get mock router object

ContentPagesTest::getMockThemeInfo() — Method in class ContentPagesTest

Get mock ThemeInfo object

IndexTest::getMockIdFetcher() — Method in class IndexTest

Get a mock ID fetcher

WriterTest::getMockChangeTracker() — Method in class WriterTest

Get mock change tracker

WriterTest::getMockSearchService() — Method in class WriterTest

Create a mock search service for a single command and its result

WriterTest::getWriter() — Method in class WriterTest

Create a Writer for a single command and its result

ThemeCompilerTest::getThemeCompiler() — Method in class ThemeCompilerTest

Get a test ThemeCompiler object

ThemeInfoTest::getThemeInfo() — Method in class ThemeInfoTest

Get a test object

AbstractMakeTagTest::getViewWithHelpers() — Method in class AbstractMakeTagTest

Get makeTag helper with mock view

AjaxHandlerTest::getMockUser() — Method in class AjaxHandlerTest

Create mock user object.

AjaxHandlerTest::getMockAuthManager() — Method in class AjaxHandlerTest

Get an auth manager with a value set for isLoggedIn.

AjaxHandlerTest::getParamsHelper() — Method in class AjaxHandlerTest

Build a Params helper for testing.

RecommendDeferredTestCase::getRecommend() — Method in class RecommendDeferredTestCase

Get a fully configured module

RecommendDeferredTestCase::getMockResults() — Method in class RecommendDeferredTestCase

Get a mock results object.

RecommendDeferredTestCase::getMockParams() — Method in class RecommendDeferredTestCase

Get a mock params object.

SessionHandlerTestCase::getTables() — Method in class SessionHandlerTestCase

Get mock database plugin manager

VuFindHighlighterTest::getHighlightDataProvider() — Method in class VuFindHighlighterTest
DatabaseTest::getShortener() — Method in class DatabaseTest

Get the object to test.

DatabaseTest::getMockTable() — Method in class DatabaseTest

Get the mock table object.

ParentTemplateTest::getHelper() — Method in class ParentTemplateTest

Get a populated resource container for testing.

AlphaBrowseTest::getMockUrlHelper() — Method in class AlphaBrowseTest

Get mock URL helper.

AlphaBrowseTest::getHelper() — Method in class AlphaBrowseTest

Get configured AlphaBrowse helper for testing.

ComponentTest::getHelper() — Method in class ComponentTest

Get view helper to test.

CookieConsentTest::getCookieConsent() — Method in class CookieConsentTest

Create a CookieConsent helper

CookieConsentTest::getExpectedRenderParams() — Method in class CookieConsentTest

Get expected params for the render call

CookieConsentTest::getConsentConfig() — Method in class CookieConsentTest

Get cookie consent configuration

CookieConsentTest::getCookieManager() — Method in class CookieConsentTest

Get cookie manager

FlashmessagesTest::getTestFlashmessageData() — Method in class FlashmessagesTest

Data provider for testFlashmessageData

FlashmessagesTest::getFlashmessages() — Method in class FlashmessagesTest

Get a Flashmessages helper with the given messages in the queue

FlashmessagesTest::getViewHelpers() — Method in class FlashmessagesTest

Get view helpers needed by test.

GoogleAnalyticsTestClass in namespace VuFindTest\View\Helper\Root

GoogleAnalytics view helper Test Class

GoogleTagManagerTestClass in namespace VuFindTest\View\Helper\Root

GoogleTagManager view helper Test Class

HelpTextTest::getMockContentHelper() — Method in class HelpTextTest

Get a mock Content helper which will return a specific value and set a specific set of page details when renderTranslated() is called.

IconTest::getDefaultTestConfig() — Method in class IconTest

Get a default test configuration.

IconTest::getMockImageLink() — Method in class IconTest

Get a mock ImageLink helper

IconTest::getIconHelper() — Method in class IconTest

Get an Icon helper

JsTranslationsTest::getViewHelpers() — Method in class JsTranslationsTest

Get view helpers needed by test.

MakeLinkTest::getHelper() — Method in class MakeLinkTest

Get MakeLink helper with mock view

MakeTagTest::getHelper() — Method in class MakeTagTest

Get makeTag helper with mock view

MarkdownTest::getHelper() — Method in class MarkdownTest

Get view helper to test.

MetadataTest::getDriver() — Method in class MetadataTest

Get a fake record driver

MetadataTest::getMetaHelper() — Method in class MetadataTest

Get a mock HeadMeta helper

MetadataTest::getPluginManager() — Method in class MetadataTest

Get a mock plugin manager

OpenUrlTest::getMockContext() — Method in class OpenUrlTest

Get mock context helper.

OpenUrlTest::getMockDriver() — Method in class OpenUrlTest

Get mock driver that returns an openURL.

OpenUrlTest::getOpenUrl() — Method in class OpenUrlTest

Get the object to test

PermissionTest::getMockPmd() — Method in class PermissionTest

Get mock driver that returns a deniedTemplateBehavior.

PermissionTest::getMockPm() — Method in class PermissionTest

Get mock permission manager

PermissionTest::getMockContext() — Method in class PermissionTest

Get mock context helper.

PermissionTest::getMockView() — Method in class PermissionTest

Return a view object populated for these test cases.

RecordDataFormatterTest::getMockRecordRouter() — Method in class RecordDataFormatterTest

Get a mock record router.

RecordDataFormatterTest::getViewHelpers() — Method in class RecordDataFormatterTest

Get view helpers needed by test.

RecordDataFormatterTest::getDriver() — Method in class RecordDataFormatterTest

Get a record driver with fake data.

RecordDataFormatterTest::getFormatter() — Method in class RecordDataFormatterTest

Build a formatter, including necessary mock view w/ helpers.

RecordDataFormatterTest::getLabels() — Method in class RecordDataFormatterTest

Extract labels from a results array.

RecordDataFormatterTest::getFormattingData() — Method in class RecordDataFormatterTest

Data Provider for testFormatting().

RecordDataFormatterTest::getInvokedSpecs() — Method in class RecordDataFormatterTest

Invokes a RecordDataFormatter with a driver and returns getData results.

RecordDataFormatterTest::getOldSpecs() — Method in class RecordDataFormatterTest

Calls RecordDataFormatter::getData with a driver as parameter and returns the results.

RecordLinkerTest::getRecordLinker() — Method in class RecordLinkerTest

Get a RecordLinker object ready for testing.

RecordLinkerTest::getUrl() — Method in class RecordLinkerTest

Get a URL helper.

RecordTest::getRecord() — Method in class RecordTest

Get a Record object ready for testing.

RecordTest::getMockResolver() — Method in class RecordTest

Get a mock resolver object

RecordTest::getMockContext() — Method in class RecordTest

Get a mock context object

RecordTest::getMockUrl() — Method in class RecordTest

Get a mock URL helper

RecordTest::getMockServerUrl() — Method in class RecordTest

Get a mock server URL helper

RecordTest::getMockSearchTabs() — Method in class RecordTest

Get a mock search tabs view helper

RecordTest::getCoverLoader() — Method in class RecordTest

Get a loader object to test.

RecordTest::getThemeDir() — Method in class RecordTest

Get the theme directory.

SearchMemoryTest::getLastSearchParamsProvider() — Method in class SearchMemoryTest

Data provider for testGetLastSearchParams()

SearchTabsTest::getCurrentHiddenFilterParamsProvider() — Method in class SearchTabsTest

Data provider for testGetCurrentHiddenFilterParams

SearchTabsTest::getHelper() — Method in class SearchTabsTest

Get a SearchTabs helper

SetupThemeResourcesTest::getResourceContainer() — Method in class SetupThemeResourcesTest

Get a populated resource container for testing.

SetupThemeResourcesTest::getMockView() — Method in class SetupThemeResourcesTest

Get a fake view object.

SetupThemeResourcesTest::getMockHeadMeta() — Method in class SetupThemeResourcesTest

Get a fake HeadMeta helper.

SetupThemeResourcesTest::getMockHeadLink() — Method in class SetupThemeResourcesTest

Get a fake HeadLink helper.

SetupThemeResourcesTest::getMockHeadScript() — Method in class SetupThemeResourcesTest

Get a fake HeadScript helper.

SlotTest::getHelper() — Method in class SlotTest

Build Slot helper with mock view

SlotTest::getMockView() — Method in class SlotTest

Get a fake view object.

TemplatePathTest::getHelper() — Method in class TemplatePathTest

Get a populated resource container for testing.

VuFindGeoTest::getLogger() — Method in class VuFindGeoTest

Get an error logger so we can assert about messages generated by VuFindGeo.

VuFindTest::getMockContainer() — Method in class VuFindTest

Support method -- set up a mock container for testing the class.

AbstractCssPreCompiler::getAllFiles() — Method in class AbstractCssPreCompiler

Get all less files that might exist in a theme.

AbstractCssPreCompiler::getAllThemes() — Method in class AbstractCssPreCompiler

Get a list of all available themes.

AbstractThemeUtility::getLastError() — Method in class AbstractThemeUtility

Get last error message.

GeneratorInterfaceClass in namespace VuFindTheme

Interface shared by theme and mixin generator classes.

GeneratorInterface::generate() — Method in class GeneratorInterface

Generate a new resource.

GeneratorInterface::getLastError() — Method in class GeneratorInterface

Get last error message.

Initializer::getThemeOptions() — Method in class Initializer

Return an array of information about user-selectable themes. Each entry in the array is an associative array with 'name', 'desc' and 'selected' keys.

InjectTemplateListener::getPrefixes() — Method in class InjectTemplateListener

Get the prefixes recognized by the listener.

CSS::getPathConverter() — Method in class CSS

Return a converter to update relative paths to be relative to the new destination.

MixinGenerator::generate() — Method in class MixinGenerator

Generate a new mixin from a template.

Module::getAutoloaderConfig() — Method in class Module

Get autoloader configuration

Module::getConfig() — Method in class Module

Return generic configuration

Module::getServiceConfig() — Method in class Module

Return service configuration.

Module::getViewHelperConfig() — Method in class Module

Get view helper configuration.

$ ResourceContainer#generatorProperty in class ResourceContainer

Generator value for tag

ResourceContainer::getCss() — Method in class ResourceContainer

Get CSS files.

ResourceContainer::getJs() — Method in class ResourceContainer

Get Javascript files.

ResourceContainer::getEncoding() — Method in class ResourceContainer

Get the encoding.

ResourceContainer::getFavicon() — Method in class ResourceContainer

Get the favicon (null for none).

ResourceContainer::getGenerator() — Method in class ResourceContainer

Get the generator.

ThemeGenerator::generate() — Method in class ThemeGenerator

Generate a new theme from a template.

ThemeInfo::getBaseDir() — Method in class ThemeInfo

Get the base directory for themes.

ThemeInfo::getMixinConfig() — Method in class ThemeInfo

Get the configuration file for the specified mixin.

ThemeInfo::getThemeConfig() — Method in class ThemeInfo

Get the configuration file for the specified theme.

ThemeInfo::getTheme() — Method in class ThemeInfo

Get the current theme.

ThemeInfo::getThemeInfo() — Method in class ThemeInfo

Get all the configuration details related to the current theme.

ThemeInfo::getMergedConfig() — Method in class ThemeInfo

Get a configuration element, merged to reflect theme inheritance.

$ ConcatTrait#groupsProperty in class ConcatTrait

Array of resource items by type, contains key as well

ConcatTrait::getFileType() — Method in class ConcatTrait

Get the folder name and file extension

ConcatTrait::getResourceFilePath() — Method in class ConcatTrait

Get the file path from the element object

ConcatTrait::getMinifier() — Method in class ConcatTrait

Get the minifier that can handle these file types

ConcatTrait::getType() — Method in class ConcatTrait

Set the file path of the link object

ConcatTrait::getResourceCacheDir() — Method in class ConcatTrait

Get the path to the directory where we can cache files generated by this trait.

ConcatTrait::getConcatenatedFilePath() — Method in class ConcatTrait

Using the concatKey, return the path of the concatenated file.

ConcatTrait::getMinifiedData() — Method in class ConcatTrait

Get minified data for a file

HeadLink::getFileType() — Method in class HeadLink

Folder name and file extension for trait

HeadLink::getResourceFilePath() — Method in class HeadLink

Get the file path from the link object Required by ConcatTrait

HeadLink::getType() — Method in class HeadLink

Get the file type

HeadLink::getMinifier() — Method in class HeadLink

Get the minifier that can handle these file types Required by ConcatTrait

HeadLink::getWhitespace() — Method in class HeadLink
HeadLink::getIndent() — Method in class HeadLink
HeadLink::getSeparator() — Method in class HeadLink
HeadScript::getFileType() — Method in class HeadScript

Folder name and file extension for trait

HeadScript::getResourceFilePath() — Method in class HeadScript

Get the file path from the script object Required by ConcatTrait

HeadScript::getMinifier() — Method in class HeadScript

Get the minifier that can handle these file types Required by ConcatTrait

HeadScript::getMinifiedData() — Method in class HeadScript

Get minified data for a file

HeadScript::getWhitespace() — Method in class HeadScript
HeadScript::getIndent() — Method in class HeadScript
HeadScript::getSeparator() — Method in class HeadScript
PipelineInjectorFactory::getPipelineConfig() — Method in class PipelineInjectorFactory

Split config and return prefixed setting with current environment.

Slot::get() — Method in class Slot

Get current value of slot. Returns null if unset.

CheckRequestIsValid::getStatusMessage() — Method in class CheckRequestIsValid

Given a request type and a boolean success status, return an appropriate message.

GetACSuggestionsClass in namespace VuFind\AjaxHandler

"Get Autocomplete Suggestions" AJAX handler

GetACSuggestionsFactoryClass in namespace VuFind\AjaxHandler

Factory for GetACSuggestions AJAX handler.

GetFacetDataClass in namespace VuFind\AjaxHandler

"Get Facet Data" AJAX handler

GetFacetDataFactoryClass in namespace VuFind\AjaxHandler

Factory for GetFacetData AJAX handler.

GetIlsStatusClass in namespace VuFind\AjaxHandler

"Get ILS Status" AJAX handler

GetIlsStatusFactoryClass in namespace VuFind\AjaxHandler

Factory for GetIlsStatus AJAX handler.

GetItemStatusesClass in namespace VuFind\AjaxHandler

"Get Item Status" AJAX handler

GetItemStatuses::getCallnumberHandler() — Method in class GetItemStatuses

Based on settings and the number of callnumbers, return callnumber handler Use callnumbers before pickValue is run.

GetItemStatuses::getItemStatus() — Method in class GetItemStatuses

Support method for getItemStatuses() -- process a single bibliographic record for location settings other than "group".

GetItemStatuses::getItemStatusGroup() — Method in class GetItemStatuses

Support method for getItemStatuses() -- process a single bibliographic record for "group" location setting.

GetItemStatuses::getItemStatusError() — Method in class GetItemStatuses

Support method for getItemStatuses() -- process a failed record.

GetItemStatusesFactoryClass in namespace VuFind\AjaxHandler

Factory for GetItemStatus AJAX handler.

GetLibraryPickupLocationsClass in namespace VuFind\AjaxHandler

"Get Library Pickup Locations" AJAX handler

GetRecordCommentsAsHTMLClass in namespace VuFind\AjaxHandler

AJAX handler to get list of comments for a record as HTML.

GetRecordCommentsAsHTMLFactoryClass in namespace VuFind\AjaxHandler

Factory for GetRecordCommentsAsHTML AJAX handler.

GetRecordCoverClass in namespace VuFind\AjaxHandler

GetRecordCover AJAX handler.

GetRecordCoverFactoryClass in namespace VuFind\AjaxHandler

Factory for GetRecordCover AJAX handler.

GetRecordDetailsClass in namespace VuFind\AjaxHandler

"Get Record Details" AJAX handler

GetRecordDetailsFactoryClass in namespace VuFind\AjaxHandler

Factory for GetRecordDetails AJAX handler.

GetRecordRatingClass in namespace VuFind\AjaxHandler

AJAX handler to get the rating for a record.

GetRecordRatingFactoryClass in namespace VuFind\AjaxHandler

Factory for GetRecordRating AJAX handler.

GetRecordTagsClass in namespace VuFind\AjaxHandler

AJAX handler to get all tags for a record as HTML.

GetRecordTagsFactoryClass in namespace VuFind\AjaxHandler

Factory for GetRecordTags AJAX handler.

GetRecordVersionsClass in namespace VuFind\AjaxHandler

AJAX handler for fetching versions link

GetRecordVersionsFactoryClass in namespace VuFind\AjaxHandler

Factory for GetRecordVersions AJAX handler.

GetRequestGroupPickupLocationsClass in namespace VuFind\AjaxHandler

"Get Request Group Pickup Locations" AJAX handler

GetResolverLinksClass in namespace VuFind\AjaxHandler

"Get Resolver Links" AJAX handler

GetResolverLinksFactoryClass in namespace VuFind\AjaxHandler

Factory for GetResolverLinks AJAX handler.

GetResultCountClass in namespace VuFind\AjaxHandler

"Get Result Counts" AJAX Handler

GetResultCountFactoryClass in namespace VuFind\AjaxHandler

Factory for GetRecordDetails AJAX handler.

GetSaveStatusesClass in namespace VuFind\AjaxHandler

"Get Save Statuses" AJAX handler

GetSaveStatuses::getDataFromUser() — Method in class GetSaveStatuses

Obtain status data from the current logged-in user.

GetSaveStatusesFactoryClass in namespace VuFind\AjaxHandler

Factory for GetSaveStatuses AJAX handler.

GetSideFacetsClass in namespace VuFind\AjaxHandler

"Get Side Facets" AJAX handler

GetSideFacets::getFacetResults() — Method in class GetSideFacets

Perform search and return the results

GetSideFacets::getCheckboxFacetCount() — Method in class GetSideFacets

Get the result count for a checkbox facet

GetSideFacets::getHierarchicalFacetData() — Method in class GetSideFacets

Get facet data for a hierarchical facet

GetSideFacetsFactoryClass in namespace VuFind\AjaxHandler

Factory for GetSideFacets AJAX handler.

GetUserFinesClass in namespace VuFind\AjaxHandler

"Get User Fines" AJAX handler

GetUserFinesFactoryClass in namespace VuFind\AjaxHandler

Factory for GetUserFines AJAX handler.

GetUserHoldsClass in namespace VuFind\AjaxHandler

"Get User Holds" AJAX handler

GetUserILLRequestsClass in namespace VuFind\AjaxHandler

"Get User ILL Requests" AJAX handler

GetUserStorageRetrievalRequestsClass in namespace VuFind\AjaxHandler

"Get User Storage Retrieval Requests" AJAX handler

GetUserTransactionsClass in namespace VuFind\AjaxHandler

"Get User Transactions" AJAX handler

GetUserTransactions::getPaginationHelper() — Method in class GetUserTransactions

Get the ILS pagination helper

GetVisDataClass in namespace VuFind\AjaxHandler

"Get Visualization Data" AJAX handler

GetVisDataFactoryClass in namespace VuFind\AjaxHandler

Factory for GetVisData AJAX handler.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

AbstractBase::getConfig() — Method in class AbstractBase

Get configuration (load automatically if not previously set). Throw an exception if the configuration is invalid.

AbstractBase::getDelegateAuthMethod() — Method in class AbstractBase

Returns any authentication method this request should be delegated to.

AbstractBase::getSessionInitiator() — Method in class AbstractBase

Get the URL to establish a session (needed when the internal VuFind login form is inadequate). Returns false when no session initiator is needed.

AbstractBase::getCannedPolicyHint() — Method in class AbstractBase

Return a canned username or password policy hint when available

AbstractBase::getCannedPasswordPolicyHint() — Method in class AbstractBase

Return a canned password policy hint when available

AbstractBase::getPolicyConfig() — Method in class AbstractBase

Get a policy configuration

AbstractBase::getUsernamePolicy() — Method in class AbstractBase

Get username policy for a new account (e.g. minLength, maxLength)

AbstractBase::getPasswordPolicy() — Method in class AbstractBase

Get password policy for a new password (e.g. minLength, maxLength)

AbstractBase::getUserTable() — Method in class AbstractBase

Get access to the user table.

AuthToken::getHeaderValue() — Method in class AuthToken

String to be used as Authorization header value

AuthToken::getExpiresIn() — Method in class AuthToken

Return expires in value in seconds

CAS::getSessionInitiator() — Method in class CAS

Get the URL to establish a session (needed when the internal VuFind login form is inadequate). Returns false when no session initiator is needed.

CAS::getRequiredAttributes() — Method in class CAS

Extract required user attributes from the configuration.

ChoiceAuth::getPluginManager() — Method in class ChoiceAuth

Get the manager for loading other authentication plugins.

ChoiceAuth::getSelectableAuthOptions() — Method in class ChoiceAuth

Return an array of authentication options allowed by this class.

ChoiceAuth::getSelectedAuthOption() — Method in class ChoiceAuth

If an authentication strategy has been selected, return the active option.

ChoiceAuth::getSessionInitiator() — Method in class ChoiceAuth

Get the URL to establish a session (needed when the internal VuFind login form is inadequate). Returns false when no session initiator is needed.

ChoiceAuth::getUsernamePolicy() — Method in class ChoiceAuth

Username policy for a new account (e.g. minLength, maxLength)

ChoiceAuth::getPasswordPolicy() — Method in class ChoiceAuth

Password policy for a new password (e.g. minLength, maxLength)

ChoiceAuth::getDelegateAuthMethod() — Method in class ChoiceAuth

Returns any authentication method this request should be delegated to.

Database::getUsernamePolicy() — Method in class Database

Username policy for a new account (e.g. minLength, maxLength)

Database::getPasswordPolicy() — Method in class Database

Password policy for a new password (e.g. minLength, maxLength)

Facebook::getSessionInitiator() — Method in class Facebook

Get the URL to establish a session (needed when the internal VuFind login form is inadequate). Returns false when no session initiator is needed.

Facebook::getAccessTokenFromCode() — Method in class Facebook

Obtain an access token from a code.

Facebook::getDetailsFromAccessToken() — Method in class Facebook

Given an access token, look up user details.

ILS::getCatalog() — Method in class ILS

Get the ILS driver associated with this object (or load the default from the service manager.

ILS::getPasswordPolicy() — Method in class ILS

Password policy for a new password (e.g. minLength, maxLength)

ILS::getILSLoginMethod() — Method in class ILS

What login method does the ILS use (password, email, vufind)

ILS::getDelegateAuthMethod() — Method in class ILS

Returns any authentication method this request should be delegated to.

ILS::getLoggedInPatron() — Method in class ILS

Get the Currently Logged-In Patron

ILS::getUsernameField() — Method in class ILS

Gets the configured username field.

ILSAuthenticator::getStoredCatalogCredentials() — Method in class ILSAuthenticator

Get stored catalog credentials for the current user.

LDAP::getSetting() — Method in class LDAP

Get the requested configuration setting (or blank string if unset).

Manager::getAuth() — Method in class Manager

Get the authentication handler.

Manager::getUsernamePolicy() — Method in class Manager

Username policy for a new account (e.g. minLength, maxLength)

Manager::getPasswordPolicy() — Method in class Manager

Password policy for a new password (e.g. minLength, maxLength)

Manager::getSessionInitiator() — Method in class Manager

Get the URL to establish a session (needed when the internal VuFind login form is inadequate). Returns false when no session initiator is needed.

Manager::getAuthClassForTemplateRendering() — Method in class Manager

In VuFind, views are tied to the name of the active authentication class.

Manager::getSelectableAuthOptions() — Method in class Manager

Return an array of all of the authentication options supported by the current auth class. In most cases (except for ChoiceAuth), this will just contain a single value.

Manager::getLoginTargets() — Method in class Manager

Does the current auth class allow for authentication from more than one target? (e.g. MultiILS) If so return an array that lists the targets.

Manager::getDefaultLoginTarget() — Method in class Manager

Does the current auth class allow for authentication from more than one target? (e.g. MultiILS) If so return the default target.

Manager::getAuthMethod() — Method in class Manager

Get the name of the current authentication method.

Manager::getCsrfHash() — Method in class Manager

Retrieve CSRF token

Manager::getIdentity() — Method in class Manager

Get the identity

Manager::getILSLoginMethod() — Method in class Manager

What login method does the ILS use (password, email, vufind)

MultiAuth::getPluginManager() — Method in class MultiAuth

Get the manager for loading other authentication plugins.

MultiILS::getLoginTargets() — Method in class MultiILS

Get login targets (ILS drivers/source ID's)

MultiILS::getDefaultLoginTarget() — Method in class MultiILS

Get default login target (ILS driver/source ID)

PasswordAccess::getConfig() — Method in class PasswordAccess

Get configuration (load automatically if not previously set). Throw an exception if the configuration is invalid.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

Shibboleth::getSessionInitiator() — Method in class Shibboleth

Get the URL to establish a session (needed when the internal VuFind login form is inadequate). Returns false when no session initiator is needed.

Shibboleth::getConfigurationLoader() — Method in class Shibboleth

Return configuration loader

Shibboleth::getRequiredAttributes() — Method in class Shibboleth

Extract required user attributes from the configuration.

Shibboleth::getCurrentEntityId() — Method in class Shibboleth

Fetch entityId used for authentication

Shibboleth::getAttribute() — Method in class Shibboleth

Extract attribute from request.

ShibbolethFactory::getConfigurationLoader() — Method in class ShibbolethFactory

Return configuration loader for shibboleth

ConfigurationLoaderInterface::getConfiguration() — Method in class ConfigurationLoaderInterface

Return shibboleth configuration.

MultiIdPConfigurationLoader::getConfiguration() — Method in class MultiIdPConfigurationLoader

Return shibboleth configuration.

SingleIdPConfigurationLoader::getConfiguration() — Method in class SingleIdPConfigurationLoader

Return shibboleth configuration.

AutocompleteInterface::getSuggestions() — Method in class AutocompleteInterface

This method returns an array of strings matching the user's query for display in the autocomplete box.

Eds::getSuggestions() — Method in class Eds

This method returns an array of strings matching the user's query for display in the autocomplete box.

None::getSuggestions() — Method in class None

This method returns an array of strings matching the user's query for display in the autocomplete box.

OCLCIdentities::getSuggestions() — Method in class OCLCIdentities

This method returns an array of strings matching the user's query for display in the autocomplete box.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

Solr::getSuggestions() — Method in class Solr

This method returns an array of strings matching the user's query for display in the autocomplete box.

Solr::getSuggestionsFromSearch() — Method in class Solr

Try to turn an array of record drivers into an array of suggestions.

SolrPrefix::getSuggestions() — Method in class SolrPrefix

Get suggestions

Suggester::getSuggestions() — Method in class Suggester

This returns an array of suggestions based on current request parameters.

Tag::getSuggestions() — Method in class Tag

This method returns an array of strings matching the user's query for display in the autocomplete box.

Tag::getTagsTable() — Method in class Tag

Get access to the user table.

Importer::getConfiguration() — Method in class Importer

Load and set up the configuration object.

ImporterConfig::getBatchSize() — Method in class ImporterConfig

Get batch size setting

ImporterConfig::getEncoding() — Method in class ImporterConfig

Get encoding setting

ImporterConfig::getColumn() — Method in class ImporterConfig

Get configuration for the specified column.

ImporterConfig::getField() — Method in class ImporterConfig

Get configuration for the specified field.

ImporterConfig::getAllFields() — Method in class ImporterConfig

Get all field names

ImporterConfig::getOutstandingCallbacks() — Method in class ImporterConfig

Get a list of fields with callbacks that have not already been processed.

ImporterConfig::getFixedFieldValues() — Method in class ImporterConfig

Initialize a field array with any fixed values configured here.

CacheTrait::getCachedData() — Method in class CacheTrait

Helper function for fetching cached data.

KeyGeneratorTrait::getCacheKey() — Method in class KeyGeneratorTrait

Method to ensure uniform cache keys for cached VuFind objects.

Manager::getCache() — Method in class Manager

Retrieve the specified cache object.

Manager::getCacheDir() — Method in class Manager

Get the path to the directory containing VuFind's cache data.

Manager::getCacheList() — Method in class Manager

Get the names of all available caches.

AbstractBase::getJsIncludes() — Method in class AbstractBase

Get list of URLs with JS dependancies to load for the active CAPTCHA type.

AbstractBase::getId() — Method in class AbstractBase

Get ID for current CAPTCHA (to use e.g. in HTML forms)

AbstractBase::getErrorMessage() — Method in class AbstractBase

Get any error message after a failed captcha verification. The message can be displayed to the user.

Image::getCacheBasePath() — Method in class Image

Getter for template

Interval::getErrorMessage() — Method in class Interval

Get any error message after a failed captcha verification. The message can be displayed to the user.

LaminasBase::getCaptcha() — Method in class LaminasBase

Laminas CAPTCHA object

LaminasBase::getHtmlInternalId() — Method in class LaminasBase

Getter for template

LaminasBase::getHtmlInputId() — Method in class LaminasBase

Getter for template

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

ReCaptcha::getJsIncludes() — Method in class ReCaptcha

Get list of URLs with JS dependancies to load for the active CAPTCHA type.

ReCaptcha::getHtml() — Method in class ReCaptcha

Generate HTML depending on CAPTCHA type.

Cart::getItems() — Method in class Cart

Return the contents of the cart.

Cart::getMaxSize() — Method in class Cart

Get cart size.

Cart::getCookieDomain() — Method in class Cart

Get cookie domain context (null if unset).

Cart::getCookiePath() — Method in class Cart

Get cookie path ('/' if unset).

Cart::getCookieSameSite() — Method in class Cart

Get cookie SameSite attribute.

Cart::getRecordDetails() — Method in class Cart

Process parameters and return the cart content.

AbstractILSChannelProvider::getFromRecord() — Method in class AbstractILSChannelProvider

Return channel information derived from a record driver object.

AbstractILSChannelProvider::getFromSearch() — Method in class AbstractILSChannelProvider

Return channel information derived from a search results object.

AbstractILSChannelProvider::getIlsResponse() — Method in class AbstractILSChannelProvider

Retrieve data from the ILS.

AbstractILSChannelProvider::getChannel() — Method in class AbstractILSChannelProvider

Recently returned channel contents are always the same; this does not care about specific records or search parameters.

AlphaBrowse::getFromRecord() — Method in class AlphaBrowse

Return channel information derived from a record driver object.

AlphaBrowse::getFromSearch() — Method in class AlphaBrowse

Return channel information derived from a search results object.

ChannelLoader::getChannelsFromResults() — Method in class ChannelLoader

Get channel details using an array of providers and a populated search results object.

ChannelLoader::getChannelProviders() — Method in class ChannelLoader

Get an array of channel providers matching the provided IDs (or just one, if the channelProvider GET parameter is set).

ChannelLoader::getChannelProvider() — Method in class ChannelLoader

Convenience method to retrieve a channel provider.

ChannelLoader::getHomeContext() — Method in class ChannelLoader

Generates static front page of channels.

ChannelLoader::getRecordContext() — Method in class ChannelLoader

Generates channels for a record.

ChannelLoader::getSearchContext() — Method in class ChannelLoader

Generates channels for a search.

ChannelProviderInterface::getFromRecord() — Method in class ChannelProviderInterface

Return channel information derived from a record driver object.

ChannelProviderInterface::getFromSearch() — Method in class ChannelProviderInterface

Return channel information derived from a search results object.

Facets::getFromRecord() — Method in class Facets

Return channel information derived from a record driver object.

Facets::getFromSearch() — Method in class Facets

Return channel information derived from a search results object.

Facets::getToken() — Method in class Facets

Turn a filter and title into a token.

ListItems::getFromRecord() — Method in class ListItems

Return channel information derived from a record driver object.

ListItems::getFromSearch() — Method in class ListItems

Return channel information derived from a search results object.

ListItems::getListsById() — Method in class ListItems

Get a list of lists, identified by ID; filter to public lists only.

ListItems::getLists() — Method in class ListItems

Get a list of public lists to display:

ListItems::getListsByTagAndId() — Method in class ListItems

Get a list of public lists, identified by ID and tag.

ListItems::getChannelFromList() — Method in class ListItems

Given a list object, return a channel array.

NewILSItems::getIlsResponse() — Method in class NewILSItems

Retrieve data from the ILS.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

Random::getFromRecord() — Method in class Random

Return channel information derived from a record driver object.

Random::getFromSearch() — Method in class Random

Return channel information derived from a search results object.

RecentlyReturned::getIlsResponse() — Method in class RecentlyReturned

Retrieve data from the ILS.

SimilarItems::getFromRecord() — Method in class SimilarItems

Return channel information derived from a record driver object.

SimilarItems::getFromSearch() — Method in class SimilarItems

Return channel information derived from a search results object.

TrendingILSItems::getIlsResponse() — Method in class TrendingILSItems

Retrieve data from the ILS.

AccountCapabilities::getCommentSetting() — Method in class AccountCapabilities

Get comment setting.

AccountCapabilities::getListSetting() — Method in class AccountCapabilities

Get list setting.

AccountCapabilities::getSavedSearchSetting() — Method in class AccountCapabilities

Get saved search setting.

AccountCapabilities::getTagSetting() — Method in class AccountCapabilities

Get tag setting.

AccountCapabilities::getListTagSetting() — Method in class AccountCapabilities

Get list tag setting.

AccountCapabilities::getSmsSetting() — Method in class AccountCapabilities

Get SMS setting ('enabled' or 'disabled').

Locator::getLocalConfigPath() — Method in class Locator

Get the file path to the local configuration file (null if none found).

Locator::getBaseConfigPath() — Method in class Locator

Get the file path to the base configuration file.

Locator::getConfigPath() — Method in class Locator

Get the file path to a config file.

Locator::getPathResolver() — Method in class Locator

Get a PathResolver with default configuration file paths

PathResolver::getLocalConfigPath() — Method in class PathResolver

Get the file path to the local configuration file (null if none found).

PathResolver::getBaseConfigPath() — Method in class PathResolver

Get the file path to the base configuration file.

PathResolver::getConfigPath() — Method in class PathResolver

Get the file path to a config file.

CacheDecorator::generateKey() — Method in class CacheDecorator

Return a cache key.

Upgrade::getNewConfigs() — Method in class Upgrade

Get processed configurations (used by test routines).

Upgrade::getWarnings() — Method in class Upgrade

Get warning strings generated during upgrade process.

Upgrade::getOldConfigPath() — Method in class Upgrade

Find the path to the old configuration file.

Version::getBuildVersion() — Method in class Version

Extract version number from the build.xml file of the running instance or another instance pointed to by $dir

Writer::getContent() — Method in class Writer

Get the modified file's contents as a string.

YamlReader::get() — Method in class YamlReader

Return a configuration

YamlReader::getFromPaths() — Method in class YamlReader

Given core and local filenames, retrieve the configuration data.

YamlReader::getArrayElemRefByPath() — Method in class YamlReader

Return array element reference by path

OpenLibrary::getSubjects() — Method in class OpenLibrary

Returns an array of elements for each work matching the parameters. An API call will be made for each subjectType until data is returned

Oracle::getHandle() — Method in class Oracle

Get access to the Oracle handle.

Oracle::getDataTypeConstant() — Method in class Oracle

Convert data type name into constant

Oracle::getLastError() — Method in class Oracle

Error Retrieval -- last error message.

Oracle::getLastErrorType() — Method in class Oracle

Error Retrieval -- last error type.

Oracle::getLastSql() — Method in class Oracle

Error Retrieval -- SQL that triggered last error.

Oracle::getHtmlError() — Method in class Oracle

Error Retrieval -- full details formatted as HTML.

Relais::getDefaultData() — Method in class Relais

Get default data to send to API.

Relais::getOclcRequestData() — Method in class Relais

Format the parameters needed to look up an OCLC number in the API.

Wikipedia::get() — Method in class Wikipedia

This method is responsible for connecting to Wikipedia via the REST API and pulling the content for the relevant author.

Wikipedia::getWikipediaImageURL() — Method in class Wikipedia

This method is responsible for obtaining an image URL based on a name.

WorldCatUtils::getIdentitiesQuery() — Method in class WorldCatUtils

Support function for getRelatedIdentities() -- parse a name into a query for WorldCat Identities.

WorldCatUtils::getRelatedIdentitiesUrl() — Method in class WorldCatUtils

Get the URL to perform a related identities query.

WorldCatUtils::getRelatedIdentities() — Method in class WorldCatUtils

Given a name string, get related identities. Inspired by Eric Lease Morgan's Name Finder demo (http://zoia.library.nd.edu/sandbox/name-finder/).

AbstractBase::getContext() — Method in class AbstractBase

Return context variables used for rendering the block's template.

BlockLoader::getFromSearchClassId() — Method in class BlockLoader

Fetch blocks using a search class ID.

BlockLoader::getFromOptions() — Method in class BlockLoader

Fetch blocks using an Options object.

BlockLoader::getFromConfig() — Method in class BlockLoader

Fetch blocks using a configuration name

BlockLoader::getFromConfigObject() — Method in class BlockLoader

Fetch blocks using Config object.

Channels::getContext() — Method in class Channels

Return context variables used for rendering the block's template.

ContentBlockInterface::getContext() — Method in class ContentBlockInterface

Return context variables used for rendering the block's template.

FacetList::getHierarchicalFacets() — Method in class FacetList

Get an array of hierarchical facets

FacetList::getHierarchicalFacetSortSettings() — Method in class FacetList

Get hierarchical facet sort settings

FacetList::getContext() — Method in class FacetList

Return context variables used for rendering the block's template.

IlsStatusMonitor::getContext() — Method in class IlsStatusMonitor

Return context variables used for rendering the block's template.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

TemplateBased::getContext() — Method in class TemplateBased

Return context variables used for rendering the block's template.

TemplateBased::getContextForMd() — Method in class TemplateBased

Return context array for markdown

TemplateBased::getContextForPhtml() — Method in class TemplateBased

Return context array of phtml

AbstractBase::getIsbn10() — Method in class AbstractBase

Attempt to get an ISBN-10; revert to ISBN-13 only when ISBN-10 representation is impossible.

AbstractBase::getHttpClient() — Method in class AbstractBase

Get an HTTP client

AbstractCover::getUrl() — Method in class AbstractCover

Get image URL for a particular API key and set of IDs (or false if invalid).

AbstractCover::getMetadata() — Method in class AbstractCover

Get cover metadata for a particular API key and set of IDs (or empty array).

AbstractCover::getMandatoryBacklinkLocations() — Method in class AbstractCover

Which location are mandatory for backlinks, available locations are the same as used for cover size determination, see coversize setting in [Content] section of config.ini

AbstractSyndetics::getHttpClient() — Method in class AbstractSyndetics

Get an HTTP client

AbstractSyndetics::getIsbnUrl() — Method in class AbstractSyndetics

Get the Syndetics URL for making a request.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

Bokinfo::getUrl() — Method in class Bokinfo

Get image URL for a particular API key and set of IDs (or false if invalid).

Bokinfo::getImageUrl() — Method in class Bokinfo

Find the image url in the XML returned from API

Booksite::getUrl() — Method in class Booksite

Get image URL for a particular API key and set of IDs (or false if invalid).

BrowZine::getUrl() — Method in class BrowZine

Get image URL for a particular API key and set of IDs (or false if invalid).

Buchhandel::getUrl() — Method in class Buchhandel

Get image URL for a particular API token and set of IDs (or false if invalid).

ContentCafe::getUrl() — Method in class ContentCafe

Get image URL for a particular API key and set of IDs (or false if invalid).

Deprecated::getUrl() — Method in class Deprecated

Get image URL for a particular API key and set of IDs (or false if invalid).

GoogleClass in namespace VuFind\Content\Covers

Google cover content loader.

Google::getHttpClient() — Method in class Google

Get an HTTP client

Google::getUrl() — Method in class Google

Get image URL for a particular API key and set of IDs (or false if invalid).

LibraryThing::getUrl() — Method in class LibraryThing

Get image URL for a particular API key and set of IDs (or false if invalid).

LocalFile::getUrl() — Method in class LocalFile

Get image location from local file storage.

ObalkyKnih::getUrl() — Method in class ObalkyKnih

Get image URL for a particular API key and set of IDs (or false if invalid).

ObalkyKnih::getMetadata() — Method in class ObalkyKnih

Get cover metadata for a particular API key and set of IDs (or empty array).

OpenLibrary::getUrl() — Method in class OpenLibrary

Get image URL for a particular API key and set of IDs (or false if invalid).

Orb::getHttpClient() — Method in class Orb

Get an HTTP client

Orb::getUrl() — Method in class Orb

Get image URL for a particular API key and set of IDs (or false if invalid).

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

Summon::getUrl() — Method in class Summon

Get image URL for a particular API key and set of IDs (or false if invalid).

Syndetics::getUrl() — Method in class Syndetics

Get image URL for a particular API key and set of IDs (or false if invalid).

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

Factory::getConfigSettingName() — Method in class Factory

Get the configuration setting name to get content provider settings.

Factory::getPluginManagerServiceName() — Method in class Factory

Get the plugin manager service name to build a content provider service.

Loader::getIsbnObject() — Method in class Loader

Build an ISBN object; return false if value is invalid.

ObalkyKnihService::getHttpClient() — Method in class ObalkyKnihService

Get an HTTP client

ObalkyKnihService::getData() — Method in class ObalkyKnihService

Get data from cache, or from service

ObalkyKnihService::getFromService() — Method in class ObalkyKnihService

Get data from service

ObalkyKnihService::getBaseUrl() — Method in class ObalkyKnihService

Get currently available base URL

ObalkyKnihService::getAliveUrl() — Method in class ObalkyKnihService

Check base URLs and return the first available

PageLocator::generateTemplateFromPattern() — Method in class PageLocator

Generate a template from a file search pattern. Examples:

  • %pathPrefix%/%pageName%{_%language%} => content/help_en
  • %pathPrefix%/%language%/%pageName% => HelpTranslations/en/search
PageLocator::getTemplateOptionsFromPattern() — Method in class PageLocator

Try to find a template using 1) Current language 2) Default language 3) No language

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

GuardianClass in namespace VuFind\Content\Reviews

Guardian review content loader.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

AbstractBase::getAccessPermission() — Method in class AbstractBase

Getter for access permission.

AbstractBase::getRequest() — Method in class AbstractBase

Get request object

AbstractBase::getAuthManager() — Method in class AbstractBase

Get the account manager object.

AbstractBase::getAuthorizationService() — Method in class AbstractBase

Get the authorization service (note that we're doing this on-demand rather than through injection with the AuthorizationServiceAwareInterface to minimize expensive initialization when authorization is not needed.

AbstractBase::getILSAuthenticator() — Method in class AbstractBase

Get the ILS authenticator.

AbstractBase::getUser() — Method in class AbstractBase

Get the user object if logged in, false otherwise.

AbstractBase::getViewRenderer() — Method in class AbstractBase

Get the view renderer

AbstractBase::getConfig() — Method in class AbstractBase

Get a VuFind configuration.

AbstractBase::getILS() — Method in class AbstractBase

Get the ILS connection.

AbstractBase::getRecordLoader() — Method in class AbstractBase

Get the record loader

AbstractBase::getRecordCache() — Method in class AbstractBase

Get the record cache

AbstractBase::getRecordRouter() — Method in class AbstractBase

Get the record router.

AbstractBase::getTable() — Method in class AbstractBase

Get a database table object.

AbstractBase::getServerUrl() — Method in class AbstractBase

Get the full URL to one of VuFind's routes.

AbstractBase::getSearchMemory() — Method in class AbstractBase

Get the search memory

AbstractBase::getFollowupUrl() — Method in class AbstractBase

Retrieve a referer to keep post-login redirect pointing to an appropriate location.

AbstractBase::getRecordTabManager() — Method in class AbstractBase

Get the tab configuration for this controller.

AbstractBase::getILSLoginMethod() — Method in class AbstractBase

What login method does the ILS use (password, email, vufind)

AbstractBase::getILSLoginSettings() — Method in class AbstractBase

Get settings required for displaying the catalog login form

AbstractBase::getRefreshResponse() — Method in class AbstractBase

Construct an HTTP 205 (refresh) response. Useful for reporting success in the lightbox without actually rendering content.

AbstractRecord::getDefaultTab() — Method in class AbstractRecord

Get default tab for a given driver

AbstractRecord::getAllTabs() — Method in class AbstractRecord

Get all tab information for a given driver.

AbstractRecord::getBackgroundTabs() — Method in class AbstractRecord

Get names of tabs to be loaded in the background.

AbstractRecord::getTabsExtraScripts() — Method in class AbstractRecord

Get extra scripts required by tabs.

AbstractSearch::getActiveRecommendationSettings() — Method in class AbstractSearch

Get active recommendation module settings

AbstractSearch::getSearchSetupCallback() — Method in class AbstractSearch

Get a callback for setting up a search (or null if callback is unnecessary).

AbstractSearch::getRssSearchResponse() — Method in class AbstractSearch

Support method for getSearchResultsView() -- return the search results reformatted as an RSS feed.

AbstractSearch::getSearchResultsView() — Method in class AbstractSearch

Perform a search and send results to a results view

AbstractSearch::getResultsManager() — Method in class AbstractSearch

Convenience method for accessing results

AbstractSearch::getRangeSettings() — Method in class AbstractSearch

Get the current settings for the specified range facet, if it is set:

AbstractSearch::getRangeFieldList() — Method in class AbstractSearch

Get the range facet configurations from the specified config section and filter them appropriately.

AbstractSearch::getDateRangeSettings() — Method in class AbstractSearch

Get the current settings for the date range facets, if set:

AbstractSearch::getFullDateRangeSettings() — Method in class AbstractSearch

Get the current settings for the full date range facets, if set:

AbstractSearch::getGenericRangeSettings() — Method in class AbstractSearch

Get the current settings for the generic range facets, if set:

AbstractSearch::getNumericRangeSettings() — Method in class AbstractSearch

Get the current settings for the numeric range facets, if set:

AbstractSearch::getAllRangeSettings() — Method in class AbstractSearch

Get all active range facets:

AbstractSolrSearch::getIllustrationSettings() — Method in class AbstractSolrSearch

Get the possible legal values for the illustration limit radio buttons.

AbstractSolrSearch::getHierarchicalFacets() — Method in class AbstractSolrSearch

Get an array of hierarchical facets

AbstractSolrSearch::getAdvancedHierarchicalFacetsSortOptions() — Method in class AbstractSolrSearch

Get an array of hierarchical facet sort options for Advanced search

AjaxResponseTrait::getAjaxResponse() — Method in class AjaxResponseTrait

Send output data and exit.

AjaxResponseTrait::getExceptionResponse() — Method in class AjaxResponseTrait

Turn an exception into error response.

AlphabrowseController::getTypes() — Method in class AlphabrowseController

Get browse types from config file, or use defaults if unavailable.

AlphabrowseController::getExtras() — Method in class AlphabrowseController

Load any extras from config file, or use defaults if unavailable.

BrowseController::getCurrentAction() — Method in class BrowseController

Get the name of the current action.

BrowseController::getActiveBrowseOptions() — Method in class BrowseController

Determine which browse options to display, and in which order. Returns an array of browse options in the configured order.

BrowseController::genreAction() — Method in class BrowseController

Browse Genre

BrowseController::getSecondaryList() — Method in class BrowseController

Get array with two values: a filter name and a secondary list based on facets

BrowseController::getFacetList() — Method in class BrowseController

Get a list of items from a facet.

BrowseController::getCategory() — Method in class BrowseController

Get the facet search term for an action

BrowseController::getAlphabetList() — Method in class BrowseController

Get a list of letters to display in alphabetical mode.

CartController::getCart() — Method in class CartController

Get the cart object.

CartController::getCartActionFromRequest() — Method in class CartController

Figure out an action from the request.

CartController::getExport() — Method in class CartController

Access export tools.

CollectionController::getRecordTabManager() — Method in class CollectionController

Get the tab configuration for this controller.

CollectionsController::getBrowseDelimiter() — Method in class CollectionsController

Get the delimiter used to separate title from ID in the browse strings.

CollectionsController::getAlphabetList() — Method in class CollectionsController

Get a list of initial letters to display.

CollectionsController::getBrowseLimit() — Method in class CollectionsController

Get the collection browse page size

CollectionsController::getCollectionsFromTitle() — Method in class CollectionsController

Get collection information matching a given title:

CombinedController::getTabConfig() — Method in class CombinedController

Get tab configuration based on the full combined results configuration.

ContentController::getViewForMd() — Method in class ContentController

Get ViewModel for markdown based page

ContentController::getViewForPhtml() — Method in class ContentController

Get ViewModel for phtml base page

CoverController::getImageParams() — Method in class CoverController

Convert image parameters into an array for use by the image loader.

EdsController::getAdvancedFacets() — Method in class EdsController

Return a Search Results object containing advanced facet information. This data may come from the cache.

ConfigPathTrait::getBaseConfigFilePath() — Method in class ConfigPathTrait

Get path to base configuration file

ConfigPathTrait::getForcedLocalConfigPath() — Method in class ConfigPathTrait

Get path to local configuration file (even if it does not yet exist)

ResponseFormatterTrait::getJsonResponse() — Method in class ResponseFormatterTrait

Get a JSON response from an array of data

HierarchyController::gettreeAction() — Method in class HierarchyController

Gets a Hierarchy Tree

HierarchyController::gettreejsonAction() — Method in class HierarchyController

Gets a Hierarchy Tree

HierarchyController::getrecordAction() — Method in class HierarchyController

Get a record for display within a tree

HoldsController::getPickupLocationsForEdit() — Method in class HoldsController

Get list of pickup locations based on the first selected hold. This may not be perfect as pickup locations may differ per hold, but it's the best we can do.

HoldsController::getUpdateFieldsFromGatheredDetails() — Method in class HoldsController

Get fields to update from details gathered from the user

HoldsController::getHoldUpdateResultsContainer() — Method in class HoldsController

Return a session container for hold update results.

HoldsController::getCacheId() — Method in class HoldsController

Get a unique cache id for a patron

InstallController::getPreCommands() — Method in class InstallController

Get SQL commands needed to set up a particular database before loading the main SQL file of table definitions.

InstallController::getPostCommands() — Method in class InstallController

Get SQL commands needed to set up a particular database after loading the main SQL file of table definitions.

InstallController::getMinimalPhpVersion() — Method in class InstallController

Get minimal PHP version required for VuFind to run.

InstallController::getMinimalPhpVersionId() — Method in class InstallController

Get minimal PHP version ID required for VuFind to run.

InstallController::getComposerJson() — Method in class InstallController

Get composer.json data as array

MyResearchController::getSearchRowSecurely() — Method in class MyResearchController

Get a search row, but throw an exception if it is not owned by the specified user or current active session.

MyResearchController::getUserVerificationContainer() — Method in class MyResearchController

Return a session container for use in user email verification.

MyResearchController::getSessionInitiator() — Method in class MyResearchController

Convenience method to get a session initiator URL. Returns false if not applicable.

MyResearchController::getHashAge() — Method in class MyResearchController

Helper function for verification hashes

MyResearchController::getPaginationHelper() — Method in class MyResearchController

Get the ILS pagination helper

OAuth2ControllerFactory::getAuthorizationServerFactory() — Method in class OAuth2ControllerFactory

Return a factory function for creating the authorization server.

OAuth2ControllerFactory::getResourceServerFactory() — Method in class OAuth2ControllerFactory

Return a ResourceServer.

OAuth2ControllerFactory::getResponseType() — Method in class OAuth2ControllerFactory

Return an OAuth2 response type.

OAuth2ControllerFactory::getClaimExtractor() — Method in class OAuth2ControllerFactory

Get the claim extractor.

OAuth2ControllerFactory::getOAuth2ServerSetting() — Method in class OAuth2ControllerFactory

Return a server setting from the OAuth2 configuration.

OAuth2ControllerFactory::getKeyFromConfigPath() — Method in class OAuth2ControllerFactory

Return a key path from the OAuth2 configuration.

OverdriveController::getStatusAction() — Method in class OverdriveController

Get Status Action Supports the ajax getStatus calls

AbstractRequestBase::getSession() — Method in class AbstractRequestBase

Grab the Container object for storing helper-specific session data.

AbstractRequestBase::getDefaultRequiredDate() — Method in class AbstractRequestBase

Getting a default required date based on hold settings.

AbstractRequestBase::getDateFromArray() — Method in class AbstractRequestBase

Support method for getDefaultRequiredDate() -- generate a date based on a days/months/years offset array.

AbstractRequestBase::getValidIds() — Method in class AbstractRequestBase

Get remembered valid IDs

DbUpgrade::getAdapter() — Method in class DbUpgrade

Get the database adapter.

DbUpgrade::getTableInfo() — Method in class DbUpgrade

Load table metadata.

DbUpgrade::getAllTables() — Method in class DbUpgrade

Get a list of all tables in the database.

DbUpgrade::getCharsetAndCollationProblemsForTableColumns() — Method in class DbUpgrade

Support method for getCharsetAndCollationProblemsForTable() -- get column details

DbUpgrade::getTableStatus() — Method in class DbUpgrade

Retrieve (and statically cache) table status information.

DbUpgrade::getCharsetAndCollationProblemsForTable() — Method in class DbUpgrade

Check whether the actual table charset and collation match the expected ones; return false if there is no problem, the desired character set and collation otherwise.

DbUpgrade::getCharsetAndCollationProblems() — Method in class DbUpgrade

Get information on character set and collation problems. Return value is an associative array of table name => correct character set and collation values.

DbUpgrade::getTableColumns() — Method in class DbUpgrade

Get information on all columns in a table, keyed by column name.

DbUpgrade::getTableConstraints() — Method in class DbUpgrade

Get information on all constraints in a table, keyed by type and constraint name. Primary key is double-keyed as ['primary']['primary'] to keep the structure consistent (since primary keys are not explicitly named in the source SQL).

DbUpgrade::getMissingTables() — Method in class DbUpgrade

Get a list of missing tables in the database.

DbUpgrade::getMissingColumns() — Method in class DbUpgrade

Get a list of missing columns in the database tables (associative array, key = table name, value = array of missing column definitions).

DbUpgrade::getMissingConstraints() — Method in class DbUpgrade

Get a list of missing constraints in the database tables (associative array, key = table name, value = array of missing constraint definitions).

DbUpgrade::getModifiedConstraints() — Method in class DbUpgrade

Get a list of modified constraints in the database tables (associative array, key = table name, value = array of modified constraint definitions).

DbUpgrade::getModifiedColumns() — Method in class DbUpgrade

Get a list of changed columns in the database tables (associative array, key = table name, value = array of column name => new data type).

DbUpgrade::getModifiedKeys() — Method in class DbUpgrade

Get a list of modified keys in the database tables (associative array, key = table name, value = array of modified key definitions).

Favorites::getList() — Method in class Favorites

Support method for saveBulk() -- get list to save records into. Either retrieves existing list or creates a new one.

IlsRecords::getDrivers() — Method in class IlsRecords

Get record driver objects corresponding to an array of record arrays returned by an ILS driver's methods such as getMyHolds / getMyTransactions.

NewItems::getBibIDsFromCatalog() — Method in class NewItems

Figure out which bib IDs to load from the ILS.

NewItems::getFundList() — Method in class NewItems

Get fund list

NewItems::getHiddenFilters() — Method in class NewItems

Get the hidden filter settings.

NewItems::getMaxAge() — Method in class NewItems

Get the maximum range setting (or return 0 for no limit).

NewItems::getMethod() — Method in class NewItems

Get method setting

NewItems::getRanges() — Method in class NewItems

Get range settings

NewItems::getResultPages() — Method in class NewItems

Get the result pages setting.

NewItems::getSolrFilter() — Method in class NewItems

Get a Solr filter to limit to the specified number of days.

ResultScroller::getFirstRecordId() — Method in class ResultScroller

Get the ID of the first record in the result set.

ResultScroller::getLastPageNumber() — Method in class ResultScroller

Calculate the last page number in the result set.

ResultScroller::getLastRecordId() — Method in class ResultScroller

Get the ID of the last record in the result set.

ResultScroller::getScrollData() — Method in class ResultScroller

Get the previous/next record in the last search result set relative to the current one, also return the position of the current record in the result set.

RelaisController::getRelaisUserIdentifier() — Method in class RelaisController

Given patron data from the catalogLogin() method, return the appropriate identifer for use with Relais.

ShibbolethLogoutNotificationController::getAction() — Method in class ShibbolethLogoutNotificationController

GET method handler for the logout handler

ShibbolethLogoutNotificationController::getWsdl() — Method in class ShibbolethLogoutNotificationController

Get WSDL for the service

UpgradeController::getRootDbAdapter() — Method in class UpgradeController

Get a database adapter for root access using credentials in session.

UpgradeController::getdbcredentialsAction() — Method in class UpgradeController

Prompt the user for database credentials.

UpgradeController::getsourcedirAction() — Method in class UpgradeController

Prompt the user for a source directory (to upgrade from 1.x).

UpgradeController::getsourceversionAction() — Method in class UpgradeController

Prompt the user for a source version (to upgrade from 2.x+).

$ Container#groupNameProperty in class Container

Prefix to use for cookie values.

Container::getAllValues() — Method in class Container

Get all values in the container as an associative array.

CookieManager::getCookies() — Method in class CookieManager

Get all cookie values.

CookieManager::getDomain() — Method in class CookieManager

Get the cookie domain.

CookieManager::getPath() — Method in class CookieManager

Get the cookie path.

CookieManager::getSessionName() — Method in class CookieManager

Get the name of the cookie

CookieManager::getSameSite() — Method in class CookieManager

Get the cookie SameSite attribute.

CookieManager::get() — Method in class CookieManager

Retrieve a cookie value (or null if unset).

CachingProxy::getCacheFile() — Method in class CachingProxy

Get the cache filename corresponding with the provided URL.

GeneratorClass in namespace VuFind\Cover

Dynamic Book Cover Generator

Generator::generate() — Method in class Generator

Generates a dynamic cover image from elements of the item

Generator::getBackgroundLayer() — Method in class Generator

Get the layer plugin for the background

Generator::getTextLayer() — Method in class Generator

Get the layer plugin for the text

GeneratorFactoryClass in namespace VuFind\Cover

Cover generator factory.

AbstractBackgroundLayer::getAccentColor() — Method in class AbstractBackgroundLayer

Generate an accent color from a seed value.

AbstractLayer::getColor() — Method in class AbstractLayer

Check and allocates color

AbstractLayer::getHSBColor() — Method in class AbstractLayer

Using HSB allows us to control the contrast while allowing randomness

GridBackgroundClass in namespace VuFind\Cover\Layer

Grid cover background layer

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

$ Loader#generatorProperty in class Loader

Class for rendering cover images dynamically if no API match found. Omit to disable functionality.

Loader::getCoverGeneratorSettings() — Method in class Loader

Get settings for the cover generator.

Loader::getDefaultSettings() — Method in class Loader

Get default settings for loadImage().

Loader::getImageSettingsFromLegacyArgs() — Method in class Loader

Translate legacy function arguments into new-style array.

Loader::getIdentifiers() — Method in class Loader

Get all valid identifiers as an associative array.

Loader::getCachePath() — Method in class Loader

Return a path to the image cache for the given size and ID; ensure that directories are created as needed.

Loader::getCoverUrls() — Method in class Loader

Get urls for defined provider, works as generator

Loader::getHandlers() — Method in class Loader

Return API handlers

Loader::getIdentifiersForSettings() — Method in class Loader

Get identifiers for given settings

Router::getUrl() — Method in class Router

Generate a thumbnail URL (return false if unsupported; return null to indicate that a subsequent AJAX check is needed).

Router::getMetadata() — Method in class Router

Generate a thumbnail metadata (return false if unsupported; return null to indicate that a subsequent AJAX check is needed).

HMAC::generate() — Method in class HMAC

Accepts $keysToHash, a list of array keys, and $keyValueArray, a keyed array

AdapterFactory::getAdapter() — Method in class AdapterFactory

Obtain a Laminas\DB connection using standard VuFind configuration.

AdapterFactory::getDriverName() — Method in class AdapterFactory

Translate the connection string protocol into a driver name.

AdapterFactory::getDriverOptions() — Method in class AdapterFactory

Get options for the selected driver.

AdapterFactory::getAdapterFromOptions() — Method in class AdapterFactory

Obtain a Laminas\DB connection using an option array.

AdapterFactory::getAdapterFromConnectionString() — Method in class AdapterFactory

Obtain a Laminas\DB connection using a connection string.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

RowGateway::getPrimaryKeyColumn() — Method in class RowGateway

Retrieve primary key information.

Search::getSearchObject() — Method in class Search

Get the search object from the row

Search::getUnsubscribeSecret() — Method in class Search

Utility function for generating a token for unsubscribing a saved search.

Tags::getResources() — Method in class Tags

Get all resources associated with the current tag.

User::getCatPassword() — Method in class User

This is a getter for the Catalog Password. It will return a plaintext version of the password.

User::getTags() — Method in class User

Get a list of all tags generated by the user in favorites lists. Note that the returned list WILL NOT include tags attached to records that are not saved in favorites lists.

User::getListTags() — Method in class User

Get tags assigned by the user to a favorite list.

User::getTagString() — Method in class User

Same as getTags(), but returns a string for use in edit mode rather than an array of tag objects.

User::getLists() — Method in class User

Get all of the lists associated with this user.

User::getSavedData() — Method in class User

Get information saved in a user's favorites for a particular record.

User::getLibraryCards() — Method in class User

Get all library cards associated with the user.

User::getLibraryCard() — Method in class User

Get library card data

User::getRoles() — Method in class User

Get the list of roles of this identity

UserList::getResourceTags() — Method in class UserList

Get an array of resource tags associated with this list.

UserList::getListTags() — Method in class UserList

Get an array of tags assigned to this list.

AccessToken::getByIdAndType() — Method in class AccessToken

Retrieve an object from the database based on id and type; create a new row if no existing match is found.

AccessToken::getNonce() — Method in class AccessToken

Retrieve an OpenID nonce for a user

AuthHash::getByHashAndType() — Method in class AuthHash

Retrieve an object from the database based on hash and type; create a new row if no existing match is found.

AuthHash::getLatestBySessionId() — Method in class AuthHash

Retrieve last object from the database based on session id.

ChangeTracker::getRetrieveDeletedCallback() — Method in class ChangeTracker

Build a callback function for use by the retrieveDeleted* methods.

ChangeTracker::getUtcDate() — Method in class ChangeTracker

Get a UTC time.

Comments::getForResource() — Method in class Comments

Get tags associated with the specified resource.

Comments::getStatistics() — Method in class Comments

Get statistics on use of comments.

DbTableAwareInterface::getDbTableManager() — Method in class DbTableAwareInterface

Get the plugin manager. Throw an exception if it is missing.

DbTableAwareTrait::getDbTableManager() — Method in class DbTableAwareTrait

Get the table plugin manager. Throw an exception if it is missing.

DbTableAwareTrait::getDbTable() — Method in class DbTableAwareTrait

Get a database table object.

ExpirationTrait::getExpiredBatchLastId() — Method in class ExpirationTrait

Get the highest id to delete in a batch.

ExternalSession::getByExternalSessionId() — Method in class ExternalSession

Retrieve an object from the database based on an external session ID

Feedback::getFeedbackByFilter() — Method in class Feedback

Get feedback by filter

GatewayClass in namespace VuFind\Db\Table

Generic VuFind table gateway.

Gateway::getDbTable() — Method in class Gateway

Get access to another table.

GatewayFactoryClass in namespace VuFind\Db\Table

Generic table gateway factory.

GatewayFactory::getRowPrototype() — Method in class GatewayFactory

Return row prototype object (null if unavailable)

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

Ratings::getForResource() — Method in class Ratings

Get average rating and rating count associated with the specified resource.

Ratings::getCountsForResource() — Method in class Ratings

Get rating breakdown for the specified resource.

Ratings::getStatistics() — Method in class Ratings

Get statistics on use of ratings.

Resource::getFavorites() — Method in class Resource

Get a set of records from the requested favorite list.

ResourceTags::getResourcesForTag() — Method in class ResourceTags

Get resources associated with a particular tag.

ResourceTags::getListsForTag() — Method in class ResourceTags

Get lists associated with a particular tag.

ResourceTags::getStatistics() — Method in class ResourceTags

Get statistics on use of tags.

ResourceTags::getAnonymousCount() — Method in class ResourceTags

Get count of anonymous tags

ResourceTags::getUniqueResources() — Method in class ResourceTags

Gets unique resources from the table

ResourceTags::getUniqueTags() — Method in class ResourceTags

Gets unique tags from the table

ResourceTags::getUniqueUsers() — Method in class ResourceTags

Gets unique users from the table

ResourceTags::getResourceTags() — Method in class ResourceTags

Get Resource Tags

ResourceTags::getDuplicates() — Method in class ResourceTags

Get a list of duplicate rows (this sometimes happens after merging IDs, for example after a Summon resource ID changes).

Search::getSearches() — Method in class Search

Get an array of rows for the specified user.

Search::getRowById() — Method in class Search

Get a single row matching a primary key value.

Search::getOwnedRowById() — Method in class Search

Get a single row, enforcing user ownership. Returns row if found, null otherwise.

Search::getScheduledSearches() — Method in class Search

Get scheduled searches.

Search::getSearchRowsMatchingNormalizedSearch() — Method in class Search

Return existing search table rows matching the provided normalized search.

Session::getBySessionId() — Method in class Session

Retrieve an object from the database based on session ID; create a new row if no existing match is found.

Session::garbageCollect() — Method in class Session

Garbage collect expired sessions.

Tags::getByText() — Method in class Tags

Get the row associated with a specific tag string.

Tags::getForResource() — Method in class Tags

Get tags associated with the specified resource.

Tags::getListTagsForUser() — Method in class Tags

Get a list of all tags generated by the user in favorites lists. Note that the returned list WILL NOT include tags attached to records that are not saved in favorites lists.

Tags::getForList() — Method in class Tags

Get tags assigned to a user list.

Tags::getIsMeSubquery() — Method in class Tags

Get a subquery used for flagging tag ownership (see getForResource).

Tags::getTagList() — Method in class Tags

Get a list of tags based on a sort method ($sort)

Tags::getDuplicates() — Method in class Tags

Get a list of duplicate tags (this should never happen, but past bugs and the introduction of case-insensitive tags have introduced problems).

User::getById() — Method in class User

Retrieve a user object from the database based on ID.

User::getByCatalogId() — Method in class User

Retrieve a user object from the database based on catalog ID.

User::getByUsername() — Method in class User

Retrieve a user object from the database based on username; when requested, create a new row if no existing match is found.

User::getByEmail() — Method in class User

Retrieve a user object from the database based on email.

User::getInsecureRows() — Method in class User

Get user rows with insecure passwords and/or catalog passwords

User::getByVerifyHash() — Method in class User

Return a row by a verification hash

UserList::getNew() — Method in class UserList

Create a new list object.

UserList::getExisting() — Method in class UserList

Retrieve a list object.

UserList::getListsContainingResource() — Method in class UserList

Get lists containing a specific user_resource

UserResource::getSavedData() — Method in class UserResource

Get information saved in a user's favorites for a particular record.

UserResource::getStatistics() — Method in class UserResource

Get statistics on use of lists.

UserResource::getDuplicates() — Method in class UserResource

Get a list of duplicate rows (this sometimes happens after merging IDs, for example after a Summon resource ID changes).

OverdriveConnector::getSessionContainer() — Method in class OverdriveConnector

Loads the session container

OverdriveConnector::getUser() — Method in class OverdriveConnector

Get (Logged-in) User

OverdriveConnector::getAccess() — Method in class OverdriveConnector

Get Overdrive Access

OverdriveConnector::getAvailability() — Method in class OverdriveConnector

Get Availability

OverdriveConnector::getAvailabilityBulk() — Method in class OverdriveConnector

Get Availability (in) Bulk

OverdriveConnector::getCollectionToken() — Method in class OverdriveConnector

Get Colllection Token

OverdriveConnector::getDownloadLink() — Method in class OverdriveConnector

Get Download Link for an Overdrive Resource

OverdriveConnector::getLinkTemplate() — Method in class OverdriveConnector

Returns the link template for this format

OverdriveConnector::getConfig() — Method in class OverdriveConnector

Get Configuration Sets up a local copy of configurations for convenience

OverdriveConnector::getFormatNames() — Method in class OverdriveConnector

Returns an array of Overdrive Formats and translation tokens

OverdriveConnector::getMetadata() — Method in class OverdriveConnector

Returns a hash of metadata keyed on overdrive reserveID

OverdriveConnector::getCheckout() — Method in class OverdriveConnector

Get Overdrive Checkout

OverdriveConnector::getHold() — Method in class OverdriveConnector

Get Overdrive Hold

OverdriveConnector::getCheckouts() — Method in class OverdriveConnector

Get Overdrive Checkouts (or a user)

OverdriveConnector::getHolds() — Method in class OverdriveConnector

Get Overdrive Holds (or a user)

OverdriveConnector::getHttpClient() — Method in class OverdriveConnector

Get an HTTP client

OverdriveConnector::getCachedData() — Method in class OverdriveConnector

Helper function for fetching cached data.

OverdriveConnector::getResultObject() — Method in class OverdriveConnector

Get Result Object

BrowZine::getLinks() — Method in class BrowZine

Given an array of DOIs, perform a lookup and return an associative array of arrays, keyed by DOI. Each array contains one or more associative arrays with required 'link' (URL to related resource) and 'label' (display text) keys and an optional 'icon' (URL to icon graphic) or localIcon (name of configured icon in theme) key.

BrowZine::getDoiServices() — Method in class BrowZine

Get an array of DOI services and their configuration

Demo::getLinks() — Method in class Demo

Given an array of DOIs, perform a lookup and return an associative array of arrays, keyed by DOI. Each array contains one or more associative arrays with required 'link' (URL to related resource) and 'label' (display text) keys and an optional 'icon' (URL to icon graphic) or localIcon (name of configured icon in theme) key.

DoiLinkerInterface::getLinks() — Method in class DoiLinkerInterface

Given an array of DOIs, perform a lookup and return an associative array of arrays, keyed by DOI. Each array contains one or more associative arrays with required 'link' (URL to related resource) and 'label' (display text) keys and an optional 'icon' (URL to icon graphic) or localIcon (name of configured icon in theme) key.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

Unpaywall::getLinks() — Method in class Unpaywall

Given an array of DOIs, perform a lookup and return an associative array of arrays, keyed by DOI. Each array contains one or more associative arrays with required 'link' (URL to related resource) and 'label' (display text) keys and an optional 'icon' (URL to icon graphic) or localIcon (name of configured icon in theme) key.

BadRequest::getHttpStatus() — Method in class BadRequest

Get HTTP status associated with this exception.

Forbidden::getHttpStatus() — Method in class Forbidden

Get HTTP status associated with this exception.

FormatUnavailable::getHttpStatus() — Method in class FormatUnavailable

Get HTTP status associated with this exception.

HttpDownloadException::getHttpStatus() — Method in class HttpDownloadException

Get HTTP status associated with this exception.

HttpDownloadException::getResponseBody() — Method in class HttpDownloadException

Get HTTP response body.

HttpDownloadException::getResponseHeaders() — Method in class HttpDownloadException

Get HTTP response headers.

HttpDownloadException::getUrl() — Method in class HttpDownloadException

Get URL we tried to download.

HttpStatusInterface::getHttpStatus() — Method in class HttpStatusInterface

Get HTTP status associated with this exception.

RecordMissing::getHttpStatus() — Method in class RecordMissing

Get HTTP status associated with this exception.

RecordMissing::getSeverityLevel() — Method in class RecordMissing

Get the logging severity level for this exception.

SeverityLevelInterface::getSeverityLevel() — Method in class SeverityLevelInterface

Get the logging severity level for this exception.

Export::getBulkUrl() — Method in class Export

Get the URL for bulk export.

Export::getRedirectUrl() — Method in class Export

Build callback URL for export.

Export::getFormatsForRecord() — Method in class Export

Get an array of strings representing formats in which a specified record's data may be exported (empty if none). Legal values: "BibTeX", "EndNote", "MARC", "MARCXML", "RDF", "RefWorks".

Export::getFormatsForRecords() — Method in class Export

Same return value as getFormatsForRecord(), but filtered to reflect bulk export configuration and to list only values supported by a set of records.

Export::getHeaders() — Method in class Export

Get headers for the requested format.

Export::getLabelForFormat() — Method in class Export

Get the display label for the specified export format.

Export::getBulkExportType() — Method in class Export

Get the bulk export type for the specified export format.

Export::getActiveFormats() — Method in class Export

Get active export formats for the given context.

Export::getPostField() — Method in class Export

Get the export POST field name.

Export::getTargetWindow() — Method in class Export

Get the export target window.

FavoritesService::getListObject() — Method in class FavoritesService

Get a list object for the specified ID (or 'NEW' to create a new list).

Entry::getDCDate() — Method in class Entry

Get the Dublin Core date.

Entry::getDCFormats() — Method in class Entry

Get the Dublin Core formats.

Feed::getEncoding() — Method in class Feed

Get feed encoding

Feed::getOpensearchTotalResults() — Method in class Feed

Get total results

Feed::getOpensearchStartIndex() — Method in class Feed

Get start index

Feed::getOpensearchItemsPerPage() — Method in class Feed

Get items per page

Feed::getOpensearchSearchTerms() — Method in class Feed

Get search terms

Feed::getOpensearchLinks() — Method in class Feed

Get the links

Form::getDisplayString() — Method in class Form

Get display string.

Form::getFormElementConfig() — Method in class Form

Return form element configuration.

Form::getRecipient() — Method in class Form

Return form recipient(s).

Form::getTitle() — Method in class Form

Return form title.

Form::getHelp() — Method in class Form

Return form help texts.

Form::getEmailSubject() — Method in class Form

Return form email message subject.

Form::getSubmitResponse() — Method in class Form

Return reponse that is shown after successful form submit.

Form::getEmailFromAddress() — Method in class Form

Return email from address

Form::getEmailFromName() — Method in class Form

Return email from name

Form::getInputFilter() — Method in class Form

Retrieve input filter used by this form

Form::getFormConfig() — Method in class Form

Get form configuration

Form::getElementOptions() — Method in class Form

Get options for an element

Form::getElementOptionGroups() — Method in class Form

Get option groups for an element

Form::getFormSettingFields() — Method in class Form

Return a list of field names to read from settings file.

Form::getFormElementSettingFields() — Method in class Form

Return a list of field names to read from form element settings.

Form::getFormElement() — Method in class Form

Get configuration for a Laminas form element

Form::getFormElementClass() — Method in class Form

Get form element class.

Form::getValidationMessage() — Method in class Form

Get translated validation message.

Form::getFormElements() — Method in class Form

Get form elements

Form::getElementId() — Method in class Form

Get a complete id for an element

Form::getPrimaryHandler() — Method in class Form

Get primary form handler

Form::getSecondaryHandlers() — Method in class Form

Get secondary form handlers

Form::getFormId() — Method in class Form

Get current form id/name

Email::getSender() — Method in class Email

Return email sender from configuration.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

AbstractConfig::getOptions() — Method in class AbstractConfig

Convert a config object to an options array; return empty array if configuration is missing or incomplete.

BasemapConfig::getDefaultOptions() — Method in class BasemapConfig

Set default options

BasemapConfig::getBasemap() — Method in class BasemapConfig

Get the basemap configuration settings.

BasemapConfig::getMapSelectionBasemap() — Method in class BasemapConfig

Get the basemap configuration settings for MapSelection.

BasemapConfig::getMapTabBasemap() — Method in class BasemapConfig

Get the basemap configuration settings for MapTab.

MapSelectionConfig::getDefaultOptions() — Method in class MapSelectionConfig

Set default options

MapSelectionConfig::getMapSelectionOptions() — Method in class MapSelectionConfig

Get the map tab configuration settings.

MapTabConfig::getDefaultOptions() — Method in class MapTabConfig

Set default options

MapTabConfig::getMapTabOptions() — Method in class MapTabConfig

Get the map tab configuration settings.

AbstractBase::getTreeSource() — Method in class AbstractBase

Returns the Source of the Tree

AbstractBase::getTreeRenderer() — Method in class AbstractBase

Returns the actual object for generating trees

AbstractBase::getTreeRendererType() — Method in class AbstractBase

Returns the Tree Renderer Type

AbstractBase::getTreeSettings() — Method in class AbstractBase

Get Tree Settings

AbstractBase::getTreeSourceType() — Method in class AbstractBase

Get Tree Data Source Type

ConfigurationBased::getTreeRendererType() — Method in class ConfigurationBased

Get Tree Renderer Type

ConfigurationBased::getTreeSourceType() — Method in class ConfigurationBased

Get Tree Data Source Type

ConfigurationBased::getTreeCacheTime() — Method in class ConfigurationBased

Get Tree Cache Time

ConfigurationBased::getTreeSettings() — Method in class ConfigurationBased

Get Tree Settings

ConfigurationBased::getCollectionLinkType() — Method in class ConfigurationBased

Get Collection Link Type from the config file

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

AbstractBase::getCount() — Method in class AbstractBase

Get number of nodes formatted.

AbstractBase::getData() — Method in class AbstractBase

Get the formatted metadata.

AbstractBase::getHierarchyPositionsInParents() — Method in class AbstractBase

Get the positions of this item within parent collections. Returns an array of parent ID => sequence number.

AbstractBase::getTitlesInHierarchy() — Method in class AbstractBase

Get the titles of this item within parent collections. Returns an array of parent ID => sequence number.

Json::getData() — Method in class Json

Get the formatted metadata.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

Xml::getData() — Method in class Xml

Get the formatted metadata.

AbstractBase::getHierarchyDriver() — Method in class AbstractBase

Get the hierarchy driver

AbstractBase::getCollectionRoute() — Method in class AbstractBase

Get collection page route.

AbstractBase::getRecordRoute() — Method in class AbstractBase

Get recordpage route.

AbstractBase::getXML() — Method in class AbstractBase

Get XML for the specified hierarchy ID.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

Solr::getXML() — Method in class Solr

Get XML for the specified hierarchy ID.

Solr::getDefaultSearchParams() — Method in class Solr

Get default search parameters shared by cursorMark and legacy methods.

Solr::getMapForHierarchy() — Method in class Solr

Retrieve a map of children for the provided hierarchy.

Solr::getRecord() — Method in class Solr

Get a record from Solr (return false if not found).

Solr::getJSON() — Method in class Solr

Get JSON for the specified hierarchy ID.

Solr::getFormattedData() — Method in class Solr

Get formatted data for the specified hierarchy ID.

XMLFile::getBasePath() — Method in class XMLFile

Get the base path for XML files.

XMLFile::getFilename() — Method in class XMLFile

Get the full filename for the XML file for a specific ID.

XMLFile::getXML() — Method in class XMLFile

Get XML for the specified hierarchy ID.

AbstractBase::getRecordDriver() — Method in class AbstractBase

Get the current record driver

AbstractBase::getDataSource() — Method in class AbstractBase

Get the current hierarchy data source

AbstractBase::getTreeList() — Method in class AbstractBase

Get a list of trees containing the item represented by the stored record driver.

AbstractBase::getHierarchyName() — Method in class AbstractBase

Get Hierarchy Name

JSTree::getTreeList() — Method in class JSTree

Get a list of trees containing the item represented by the stored record driver.

JSTree::getJSON() — Method in class JSTree

Render the Hierarchy Tree

JSTree::getContextualUrl() — Method in class JSTree

Use the router to build the appropriate URL based on context

JSTree::getUrlFromRouteCache() — Method in class JSTree

Get the URL for a record and cache it to avoid the relatively slow routing calls.

JSTree::getRouteNameFromDataSource() — Method in class JSTree

Get route name from data source.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

CachingDownloader::getDownloaderCache() — Method in class CachingDownloader

Get cache and initialize it, if necessary.

Request::getQuery() — Method in class Request

Return the parameter container responsible for query parameters or a single query parameter

Request::getPost() — Method in class Request

Return the parameter container responsible for post parameters or a single post parameter.

Request::getServer() — Method in class Request

Return the parameter container responsible for server parameters or a single parameter value.

HasSorterInterface::getSorter() — Method in class HasSorterInterface

Get the sorter

HasSorterTrait::getSorter() — Method in class HasSorterTrait

Get the sorter

LocaleDetectorFactory::getStrategies() — Method in class LocaleDetectorFactory

Generator for retrieving strategies.

LocaleSettings::getUserLocale() — Method in class LocaleSettings

Get the current active locale.

LocaleSettings::getDefaultLocale() — Method in class LocaleSettings

Get default locale.

LocaleSettings::getEnabledLocales() — Method in class LocaleSettings

Get an associative (code => description) array of enabled locales.

LocaleSettings::getFallbackLocales() — Method in class LocaleSettings

Get a prioritized array of locales to use when strings are missing from the primary language file.

LocaleSettings::getRightToLeftLocales() — Method in class LocaleSettings

Get an array of locales that use right-to-left formatting.

TranslatableString::getDisplayString() — Method in class TranslatableString

Return string for display if raw value has no translation available (can be further translated)

TranslatableStringInterface::getDisplayString() — Method in class TranslatableStringInterface

Return string for display if raw value has no translation available (can be further translated)

LanguageInitializerTrait::getTextDomains() — Method in class LanguageInitializerTrait

Look up all text domains.

ExtendedIni::getLanguageFilename() — Method in class ExtendedIni

Get the language file name for a language and domain

ExtendedIniReader::getTextDomain() — Method in class ExtendedIniReader

Parse a language file.

TranslatorAwareTrait::getTranslator() — Method in class TranslatorAwareTrait

Get translator object.

TranslatorAwareTrait::getTranslatorLocale() — Method in class TranslatorAwareTrait

Get the locale from the translator.

Connection::getDriverClass() — Method in class Connection

Get class name of the driver object.

Connection::getDriver() — Method in class Connection

Get access to the driver object.

Connection::getDriverConfig() — Method in class Connection

Get configuration for the ILS driver. We will load an .ini file named after the driver class if it exists; otherwise we will return an empty array.

Connection::getHelpText() — Method in class Connection

Get proper help text from the function config

Connection::getHoldsMode() — Method in class Connection

Get Holds Mode

Connection::getOfflineMode() — Method in class Connection

Get Offline Mode

Connection::getTitleHoldsMode() — Method in class Connection

Get Title Holds Mode

Connection::getHoldingsTextFieldNames() — Method in class Connection

Get Names of Textual Holdings Fields

Connection::getPasswordPolicy() — Method in class Connection

Get the password policy from the driver

Connection::getMyTransactions() — Method in class Connection

Get Patron Transactions

Connection::getHolding() — Method in class Connection

Get holdings

Connection::getStatus() — Method in class Connection
Aleph::getDefaultAddressMappings() — Method in class Aleph

Return default mapping of z304 address elements in Aleph to getMyProfile attributes.

Aleph::getStatus() — Method in class Aleph

Get Status

Aleph::getStatusesX() — Method in class Aleph

Support method for getStatuses -- load ID information from a particular bibliographic library.

Aleph::getStatuses() — Method in class Aleph

Get Statuses

Aleph::getHolding() — Method in class Aleph

Get Holding

Aleph::getMyTransactionHistory() — Method in class Aleph

Get Patron Loan History

Aleph::getMyTransactions() — Method in class Aleph

Get Patron Transactions

Aleph::getRenewDetails() — Method in class Aleph

Get Renew Details

Aleph::getMyHolds() — Method in class Aleph

Get Patron Holds

Aleph::getCancelHoldDetails() — Method in class Aleph

Get Cancel Hold Details

Aleph::getMyFines() — Method in class Aleph

Get Patron Fines

Aleph::getMyProfile() — Method in class Aleph

Get Patron Profile

Aleph::getMyProfileX() — Method in class Aleph

Get profile information using X-server.

Aleph::getMyProfileDLF() — Method in class Aleph

Get profile information using DLF service.

Aleph::getHoldingInfoForItem() — Method in class Aleph

Support method for placeHold -- get holding info for an item.

Aleph::getHoldDefaultRequiredDate() — Method in class Aleph

Get Default "Hold Required By" Date (as Unix timestamp) or null if unsupported

Aleph::getConfig() — Method in class Aleph

Public Function which retrieves historic loan, renew, hold and cancel settings from the driver ini file.

Aleph::getPickUpLocations() — Method in class Aleph

Get Pick Up Locations

Aleph::getDefaultPickUpLocation() — Method in class Aleph

Get Default Pick Up Location

Aleph::getPurchaseHistory() — Method in class Aleph

Get Purchase History

Aleph::getNewItems() — Method in class Aleph

Get New Items

Aleph::getDepartments() — Method in class Aleph

Get Departments

Aleph::getInstructors() — Method in class Aleph

Get Instructors

Aleph::getCourses() — Method in class Aleph

Get Courses

AlephRestfulException::getXmlResponse() — Method in class AlephRestfulException

Return XML response (false if none)

Alma::getAvailabilityFromItem() — Method in class Alma

Given an item, return the availability status.

Alma::getHolding() — Method in class Alma

Get Holding

Alma::getRequestBlocks() — Method in class Alma

Check for request blocks.

Alma::getAccountBlocks() — Method in class Alma

Check for account blocks in Alma and cache them.

Alma::getFulfillmentUnitByLocation() — Method in class Alma

Get an Alma fulfillment unit by an Alma location.

Alma::getMyProfile() — Method in class Alma

Get Patron Profile

Alma::getMyFines() — Method in class Alma

Get Patron Fines

Alma::getMyHolds() — Method in class Alma

Get Patron Holds

Alma::getMyStorageRetrievalRequests() — Method in class Alma

Get Patron Storage Retrieval Requests

Alma::getMyILLRequests() — Method in class Alma

Get Patron ILL Requests

Alma::getMyTransactions() — Method in class Alma

Get transactions of the current patron.

Alma::getRenewDetails() — Method in class Alma

Get Alma loan IDs for use in renewMyItems.

Alma::getStatus() — Method in class Alma

Get Status

Alma::getStatuses() — Method in class Alma

Get Statuses

Alma::getPurchaseHistory() — Method in class Alma

Get Purchase History

Alma::getConfig() — Method in class Alma

Public Function which retrieves renew, hold and cancel settings from the driver ini file.

Alma::getPickupLocations() — Method in class Alma

Get Pick Up Locations

Alma::getCourses() — Method in class Alma

Request from /courses.

Alma::getInventoryTypes() — Method in class Alma

Get the inventory types to be displayed. Possible values are: p_avail,e_avail,d_avail

Alma::getStatusesForInventoryTypes() — Method in class Alma

Get Statuses for inventory types

Alma::getPreferredEmail() — Method in class Alma

Get the preferred email address for the user (or first one if no preferred one is found)

Alma::getTranslatableString() — Method in class Alma

Gets a translatable string from an element with content and a desc attribute.

Alma::getTranslatableStatusString() — Method in class Alma

Gets a translatable string from an element with content and a desc attribute.

Alma::getItemLocation() — Method in class Alma

Get location for an item

Amicus::getStatus() — Method in class Amicus

Get Status

Amicus::getStatuses() — Method in class Amicus

Get Statuses

Amicus::getHolding() — Method in class Amicus

Get Holding

Amicus::getPurchaseHistory() — Method in class Amicus

Get Purchase History

Amicus::getMyTransactions() — Method in class Amicus

Get Patron Transactions

Amicus::getMyFines() — Method in class Amicus

Get Patron Fines

Amicus::getMyHolds() — Method in class Amicus

Get Patron Holds

Amicus::getMyProfile() — Method in class Amicus

Get Patron Profile

Amicus::getHoldLink() — Method in class Amicus

Get Hold Link

Amicus::getNewItems() — Method in class Amicus

Get New Items

Amicus::getFunds() — Method in class Amicus

Get Funds

Amicus::getSuppressedRecords() — Method in class Amicus

Get suppressed records.

DAIA::getCacheKey() — Method in class DAIA

DAIA specific override of method to ensure uniform cache keys for cached VuFind objects.

DAIA::getConfig() — Method in class DAIA

Public Function which retrieves renew, hold and cancel settings from the driver ini file.

DAIA::getHoldLink() — Method in class DAIA

Get Hold Link

DAIA::getStatus() — Method in class DAIA

Get Status

DAIA::getStatuses() — Method in class DAIA

Get Statuses

DAIA::getHolding() — Method in class DAIA

Get Holding

DAIA::getPurchaseHistory() — Method in class DAIA

Get Purchase History

DAIA::generateURI() — Method in class DAIA

Generate a DAIA URI necessary for the query

DAIA::generateMultiURIs() — Method in class DAIA

Combine several ids to DAIA Query API conform URIs

DAIA::getItemStatus() — Method in class DAIA

Returns an array with status information for provided item.

DAIA::getCustomData() — Method in class DAIA

Helper function to allow custom data in status array.

DAIA::getStatusString() — Method in class DAIA

Helper function to return an appropriate status string for current item.

DAIA::getHoldType() — Method in class DAIA

Helper function to determine the holdtype available for current item.

DAIA::getItemLimitation() — Method in class DAIA

Returns the evaluated value of the provided limitation element

DAIA::getItemDepartment() — Method in class DAIA

Returns the value of item.department.content (e.g. to be used in VuFind getStatus/getHolding array as location)

DAIA::getItemDepartmentId() — Method in class DAIA

Returns the value of item.department.id (e.g. to be used in VuFind getStatus/getHolding array as location)

DAIA::getItemDepartmentLink() — Method in class DAIA

Returns the value of item.department.href (e.g. to be used in VuFind getStatus/getHolding array for linking the location)

DAIA::getItemStorage() — Method in class DAIA

Returns the value of item.storage.content (e.g. to be used in VuFind getStatus/getHolding array as location)

DAIA::getItemStorageId() — Method in class DAIA

Returns the value of item.storage.id (e.g. to be used in VuFind getStatus/getHolding array as location)

DAIA::getItemStorageLink() — Method in class DAIA

Returns the value of item.storage.href (e.g. to be used in VuFind getStatus/getHolding array for linking the location)

DAIA::getItemLimitationContent() — Method in class DAIA

Returns the evaluated values of the provided limitations element

DAIA::getItemLimitationTypes() — Method in class DAIA

Returns the evaluated values of the provided limitations element

DAIA::getItemNumber() — Method in class DAIA

Returns the value for "number" in VuFind getStatus/getHolding array

DAIA::getItemBarcode() — Method in class DAIA

Returns the value for "location" in VuFind getStatus/getHolding array

DAIA::getItemReserveStatus() — Method in class DAIA

Returns the value for "reserve" in VuFind getStatus/getHolding array

DAIA::getItemCallnumber() — Method in class DAIA

Returns the value for "callnumber" in VuFind getStatus/getHolding array

DAIA::getAvailableItemServices() — Method in class DAIA

Returns the available services of the given set of available and unavailable services

Demo::getFakeLoc() — Method in class Demo

Generate a fake location name.

Demo::getFakeServices() — Method in class Demo

Generate fake services.

Demo::getFakeStatus() — Method in class Demo

Generate a fake status message.

Demo::getFakeCallNum() — Method in class Demo

Generate a fake call number.

Demo::getFakeCallNumPrefix() — Method in class Demo

Generate a fake call number prefix sometimes.

Demo::getRandomBibId() — Method in class Demo

Get a random ID from the Solr index.

Demo::getRandomBibIdAndTitle() — Method in class Demo

Get a random ID and title from the Solr index.

Demo::getRecordSource() — Method in class Demo

Get the name of the search backend providing records.

Demo::getRequestBlocks() — Method in class Demo

Check whether the patron is blocked from placing requests (holds/ILL/SRR).

Demo::getAccountBlocks() — Method in class Demo

Check whether the patron has any blocks on their account.

Demo::getRandomHolding() — Method in class Demo

Generates a random, fake holding array

Demo::getRandomItemIdentifier() — Method in class Demo

Generate an associative array containing some sort of ID (for cover generation).

Demo::getStatus() — Method in class Demo

Get Status

Demo::getSuppressedRecords() — Method in class Demo

Get suppressed records.

Demo::getSession() — Method in class Demo

Get the session container (constructing it on demand if not already present)

Demo::getSimulatedStatus() — Method in class Demo

Get Simulated Status (support method for getStatus/getHolding)

Demo::getStatuses() — Method in class Demo

Get Statuses

Demo::getHolding() — Method in class Demo

Get Holding

Demo::getPurchaseHistory() — Method in class Demo

Get Purchase History

Demo::getMyProfile() — Method in class Demo

Get Patron Profile

Demo::getMyFines() — Method in class Demo

Get Patron Fines

Demo::getMyHolds() — Method in class Demo

Get Patron Holds

Demo::getMyStorageRetrievalRequests() — Method in class Demo

Get Patron Storage Retrieval Requests

Demo::getMyILLRequests() — Method in class Demo

Get Patron ILL Requests

Demo::getTransactionList() — Method in class Demo

Construct a transaction list for getMyTransactions; may be random or pre-set depending on Demo.ini settings.

Demo::getRandomTransactionList() — Method in class Demo

Construct a random set of transactions for getMyTransactions().

Demo::getMyTransactions() — Method in class Demo

Get Patron Transactions

Demo::getHistoricTransactionList() — Method in class Demo

Construct a historic transaction list for getMyTransactionHistory; may be random or pre-set depending on Demo.ini settings.

Demo::getRandomHistoricTransactionList() — Method in class Demo

Construct a random set of transactions for getMyTransactionHistory().

Demo::getMyTransactionHistory() — Method in class Demo

Get Patron Loan History

Demo::getPickUpLocations() — Method in class Demo

Get Pick Up Locations

Demo::getHoldDefaultRequiredDate() — Method in class Demo

Get Default "Hold Required By" Date (as Unix timestamp) or null if unsupported

Demo::getDefaultPickUpLocation() — Method in class Demo

Get Default Pick Up Location

Demo::getDefaultRequestGroup() — Method in class Demo

Get Default Request Group

Demo::getRequestGroups() — Method in class Demo

Get request groups

Demo::getFunds() — Method in class Demo

Get Funds

Demo::getDepartments() — Method in class Demo

Get Departments

Demo::getInstructors() — Method in class Demo

Get Instructors

Demo::getCourses() — Method in class Demo

Get Courses

Demo::getRandomBibIds() — Method in class Demo

Get a set of random bib IDs

Demo::getNewItems() — Method in class Demo

Get New Items

Demo::getCourseId() — Method in class Demo

Determine a course ID for findReserves.

Demo::getDepartmentId() — Method in class Demo

Determine a department ID for findReserves.

Demo::getInstructorId() — Method in class Demo

Determine an instructor ID for findReserves.

Demo::getCancelStorageRetrievalRequestDetails() — Method in class Demo

Get Cancel Storage Retrieval Request Details

Demo::getRenewDetails() — Method in class Demo

Get Renew Details

Demo::getILLPickupLibraries() — Method in class Demo

Get ILL Pickup Libraries

Demo::getILLPickupLocations() — Method in class Demo

Get ILL Pickup Locations

Demo::getCancelILLRequestDetails() — Method in class Demo

Get Cancel ILL Request Details

Demo::getConfig() — Method in class Demo

Public Function which specifies renew, hold and cancel settings.

Demo::getRecentlyReturnedBibs() — Method in class Demo

Get bib records for recently returned items.

Demo::getTrendingBibs() — Method in class Demo

Get bib records for "trending" items (recently returned with high usage).

DriverInterface::getStatus() — Method in class DriverInterface

Get Status

DriverInterface::getStatuses() — Method in class DriverInterface

Get Statuses

DriverInterface::getHolding() — Method in class DriverInterface

Get Holding

DriverInterface::getPurchaseHistory() — Method in class DriverInterface

Get Purchase History

Evergreen::getStatus() — Method in class Evergreen

Get Status

Evergreen::getStatuses() — Method in class Evergreen

Get Statuses

Evergreen::getHolding() — Method in class Evergreen

Get Holding

Evergreen::getPurchaseHistory() — Method in class Evergreen

Get Purchase History

Evergreen::getMyTransactions() — Method in class Evergreen

Get Patron Transactions

Evergreen::getMyFines() — Method in class Evergreen

Get Patron Fines

Evergreen::getMyHolds() — Method in class Evergreen

Get Patron Holds

Evergreen::getMyProfile() — Method in class Evergreen

Get Patron Profile

Evergreen::getNewItems() — Method in class Evergreen

Get New Items

Evergreen::getFunds() — Method in class Evergreen

Get Funds

Evergreen::getSuppressedRecords() — Method in class Evergreen

Get suppressed records.

Evergreen::getDepartments() — Method in class Evergreen

Get Departments

Evergreen::getInstructors() — Method in class Evergreen

Get Instructors

Evergreen::getCourses() — Method in class Evergreen

Get Courses

Folio::getBibIdType() — Method in class Folio

Get the type of FOLIO ID used to match up with VuFind's bib IDs.

Folio::getCacheKey() — Method in class Folio

Add instance-specific context to a cache key suffix (to ensure that multiple drivers don't accidentally share values in the cache.

Folio::getInstanceById() — Method in class Folio

Given some kind of identifier (instance, holding or item), retrieve the associated instance object from FOLIO.

Folio::getBibId() — Method in class Folio

Given an instance object or identifer, or a holding or item identifier, determine an appropriate value to use as VuFind's bibliographic ID.

Folio::getInstanceByBibId() — Method in class Folio

Retrieve FOLIO instance using VuFind's chosen bibliographic identifier.

Folio::getStatus() — Method in class Folio

Get raw object of item from inventory/items/

Folio::getStatuses() — Method in class Folio

This method calls getStatus for an array of records or implement a bulk method

Folio::getConfig() — Method in class Folio

Retrieves renew, hold and cancel settings from the driver ini file.

Folio::getLocations() — Method in class Folio

Gets locations from the /locations endpoint and sets an array of location IDs to display names.

Folio::getLocationData() — Method in class Folio

Get Inventory Location Name

Folio::getHolding() — Method in class Folio

This method queries the ILS for holding information.

Folio::getDateTimeFromString() — Method in class Folio

Convert a FOLIO date string to a DateTime object.

Folio::getDueDate() — Method in class Folio

Support method for getHolding(): obtaining the Due Date from OKAPI by calling /circulation/loans with the item->id, adjusting the timezone and formatting in universal time with or without due time

Folio::getUserWithCql() — Method in class Folio

Support method for patronLogin(): authenticate the patron with a CQL looup.

Folio::getPagedResults() — Method in class Folio

Helper function to retrieve paged results from FOLIO API

Folio::getMyProfile() — Method in class Folio

This method queries the ILS for a patron's current profile information

Folio::getMyTransactions() — Method in class Folio

This method queries the ILS for a patron's current checked out items

Folio::getRenewDetails() — Method in class Folio

Get FOLIO loan IDs for use in renewMyItems.

Folio::getPickupLocations() — Method in class Folio

Get Pick Up Locations

Folio::getMyHolds() — Method in class Folio

This method queries the ILS for a patron's current holds

Folio::getCancelHoldDetails() — Method in class Folio

Get FOLIO hold IDs for use in cancelHolds.

Folio::getCourseResourceList() — Method in class Folio

Obtain a list of course resources, creating an id => value associative array.

Folio::getDepartments() — Method in class Folio

Get Departments

Folio::getInstructors() — Method in class Folio

Get Instructors

Folio::getCourses() — Method in class Folio

Get Courses

Folio::getCourseDetails() — Method in class Folio

Given a course listing ID, get an array of associated courses.

Folio::getInstructorIds() — Method in class Folio

Given a course listing ID, get an array of associated instructors.

Folio::getMyFines() — Method in class Folio

This method queries the ILS for a patron's current fines

Folio::getRequestBlocks() — Method in class Folio

Check for request blocks.

Folio::getPurchaseHistory() — Method in class Folio

This method returns information on recently received issues of a serial.

Folio::getFunds() — Method in class Folio

Get a list of funds that can be used to limit the “new item” search. Note that “fund” may be a misnomer – if funds are not an appropriate way to limit your new item results, you can return a different set of values from this function.

Folio::getMyTransactionHistory() — Method in class Folio

This method retrieves a patron's historic transactions (previously checked out items).

Folio::getNewItems() — Method in class Folio

This method queries the ILS for new items

GeniePlusClass in namespace VuFind\ILS\Driver

GeniePlus API driver

GeniePlus::getFieldFromApiRecord() — Method in class GeniePlus

Extract a field from an API response.

GeniePlus::getTemplateQueryPath() — Method in class GeniePlus

Get the search path to query a template.

GeniePlus::getStatus() — Method in class GeniePlus

Get Status

GeniePlus::getStatuses() — Method in class GeniePlus

Get Statuses

GeniePlus::getHolding() — Method in class GeniePlus

Get Holding

GeniePlus::getPurchaseHistory() — Method in class GeniePlus

Get Purchase History

GeniePlus::getConfig() — Method in class GeniePlus

Public Function which retrieves feature-specific settings from the driver ini file.

GeniePlus::getMyProfile() — Method in class GeniePlus

Get Patron Profile

GeniePlus::getMyTransactions() — Method in class GeniePlus

Get Patron Transactions

GeniePlusFactoryClass in namespace VuFind\ILS\Driver

Factory for GeniePlus ILS driver.

Horizon::getHoldingSQL() — Method in class Horizon

Protected support method for getHolding.

Horizon::getHolding() — Method in class Horizon

Get Holding

Horizon::getStatus() — Method in class Horizon

Get Status

Horizon::getStatusesSQL() — Method in class Horizon

Protected support method for getStatus.

Horizon::getStatuses() — Method in class Horizon

Get Statuses

Horizon::getPurchaseHistory() — Method in class Horizon

Get Purchase History

Horizon::getHoldsSQL() — Method in class Horizon

Protected support method for getMyHolds.

Horizon::getMyHolds() — Method in class Horizon

Get Patron Holds

Horizon::getMyFines() — Method in class Horizon

Get Patron Fines

Horizon::getMyProfile() — Method in class Horizon

Get Patron Profile

Horizon::getTransactionSQL() — Method in class Horizon

Protected support method for getMyTransactions.

Horizon::getMyTransactions() — Method in class Horizon

Get Patron Transactions

Horizon::getFunds() — Method in class Horizon

Get Funds

Horizon::getNewItems() — Method in class Horizon

Get New Items

Horizon::getSuppressedRecords() — Method in class Horizon

Get suppressed records.

HorizonXMLAPI::getConfig() — Method in class HorizonXMLAPI

Public Function which retrieves renew, hold and cancel settings from the driver ini file.

HorizonXMLAPI::getPickUpLocations() — Method in class HorizonXMLAPI

Get Pick Up Locations

HorizonXMLAPI::getDefaultPickUpLocation() — Method in class HorizonXMLAPI

Get Default Pick Up Location

HorizonXMLAPI::getSession() — Method in class HorizonXMLAPI

Get Session

HorizonXMLAPI::getItems() — Method in class HorizonXMLAPI

Get Items

HorizonXMLAPI::getRenewDetails() — Method in class HorizonXMLAPI

Get Renew Details

HorizonXMLAPI::getCancelHoldDetails() — Method in class HorizonXMLAPI

Get Cancel Hold Details

Innovative::getStatus() — Method in class Innovative

Get Status

Innovative::getStatuses() — Method in class Innovative

Get Statuses

Innovative::getHolding() — Method in class Innovative

Get Holding

Innovative::getPurchaseHistory() — Method in class Innovative

Get Purchase History

Innovative::getHoldLink() — Method in class Innovative

Get Hold Link

Innovative::getMyProfile() — Method in class Innovative

Get Patron Profile

Koha::getHolding() — Method in class Koha

Get Holding

Koha::getHoldLink() — Method in class Koha

Get Hold Link

Koha::getMyFines() — Method in class Koha

Get Patron Fines

Koha::getMyHolds() — Method in class Koha

Get Patron Holds

Koha::getMyProfile() — Method in class Koha

Get Patron Profile

Koha::getMyTransactions() — Method in class Koha

Get Patron Transactions

Koha::getAccountBlocks() — Method in class Koha

Check whether the patron has any blocks on their account.

Koha::getMyTransactionHistory() — Method in class Koha

Get Patron Loan History

Koha::getPurchaseHistory() — Method in class Koha

Get Purchase History

Koha::getStatus() — Method in class Koha

Get Status

Koha::getStatuses() — Method in class Koha

Get Statuses

Koha::getSuppressedRecords() — Method in class Koha

Get suppressed records.

Koha::getConfig() — Method in class Koha

Public Function which retrieves renew, hold and cancel settings from the driver ini file.

KohaILSDI::getDb() — Method in class KohaILSDI

Get the database connection (and make sure it is initialized).

KohaILSDI::getCacheKey() — Method in class KohaILSDI

Koha ILS-DI driver specific override of method to ensure uniform cache keys for cached VuFind objects.

KohaILSDI::getField() — Method in class KohaILSDI

Get Field

KohaILSDI::getConfig() — Method in class KohaILSDI

Public Function which retrieves renew, hold and cancel settings from the driver ini file.

KohaILSDI::getPickUpLocations() — Method in class KohaILSDI

Get Pick Up Locations

KohaILSDI::getDefaultPickUpLocation() — Method in class KohaILSDI

Get Default Pick Up Location

KohaILSDI::getHolding() — Method in class KohaILSDI

Get Holding

KohaILSDI::getNewItems() — Method in class KohaILSDI

This method queries the ILS for new items

KohaILSDI::getMyFines() — Method in class KohaILSDI

Get Patron Fines

KohaILSDI::getMyFinesILS() — Method in class KohaILSDI

Get Patron Fines

KohaILSDI::getMyHolds() — Method in class KohaILSDI

Get Patron Holds

KohaILSDI::getCancelHoldDetails() — Method in class KohaILSDI

Get Cancel Hold Details

KohaILSDI::getMyProfile() — Method in class KohaILSDI

Get Patron Profile

KohaILSDI::getAccountBlocks() — Method in class KohaILSDI

Check whether the patron has any blocks on their account.

KohaILSDI::getMyTransactionHistory() — Method in class KohaILSDI

Get Patron Loan History

KohaILSDI::getMyTransactions() — Method in class KohaILSDI

Get Patron Transactions

KohaILSDI::getRenewDetails() — Method in class KohaILSDI

Get Renew Details

KohaILSDI::getPurchaseHistory() — Method in class KohaILSDI

Get Purchase History

KohaILSDI::getStatus() — Method in class KohaILSDI

Get Status

KohaILSDI::getStatuses() — Method in class KohaILSDI

Get Statuses

KohaILSDI::getSuppressedRecords() — Method in class KohaILSDI

Get suppressed records.

KohaILSDI::getDepartments() — Method in class KohaILSDI

Get Departments

KohaILSDI::getInstructors() — Method in class KohaILSDI

Get Instructors

KohaILSDI::getCourses() — Method in class KohaILSDI

Get Courses

KohaRest::getCacheKey() — Method in class KohaRest

Method to ensure uniform cache keys for cached VuFind objects.

KohaRest::getStatus() — Method in class KohaRest

Get Status

KohaRest::getStatuses() — Method in class KohaRest

Get Statuses

KohaRest::getHolding() — Method in class KohaRest

Get Holding

KohaRest::getPurchaseHistory() — Method in class KohaRest

Get Purchase History

KohaRest::getNewItems() — Method in class KohaRest

Get New Items

KohaRest::getDepartments() — Method in class KohaRest

Get Departments

KohaRest::getInstructors() — Method in class KohaRest

Get Instructors

KohaRest::getCourses() — Method in class KohaRest

Get Courses

KohaRest::getRequestBlocks() — Method in class KohaRest

Check whether the patron is blocked from placing requests (holds/ILL/SRR).

KohaRest::getAccountBlocks() — Method in class KohaRest

Check whether the patron has any blocks on their account.

KohaRest::getMyProfile() — Method in class KohaRest

Get Patron Profile

KohaRest::getMyTransactions() — Method in class KohaRest

Get Patron Transactions

KohaRest::getRenewDetails() — Method in class KohaRest

Get Renew Details

KohaRest::getMyTransactionHistory() — Method in class KohaRest

Get Patron Transaction History

KohaRest::getMyHolds() — Method in class KohaRest

Get Patron Holds

KohaRest::getPickUpLocations() — Method in class KohaRest

Get Pick Up Locations

KohaRest::getDefaultPickUpLocation() — Method in class KohaRest

Get Default Pick Up Location

KohaRest::getMyStorageRetrievalRequests() — Method in class KohaRest

Get Patron Storage Retrieval Requests

KohaRest::getCancelStorageRetrievalRequestDetails() — Method in class KohaRest

Get Cancel Storage Retrieval Request (article request) Details

KohaRest::getMyFines() — Method in class KohaRest

Get Patron Fines

KohaRest::getConfig() — Method in class KohaRest

Public Function which retrieves renew, hold and cancel settings from the driver ini file.

KohaRest::getOAuth2Token() — Method in class KohaRest

Get a new or cached OAuth2 token (type + token)

KohaRest::getItemStatusesForBiblio() — Method in class KohaRest

Get Item Statuses

KohaRest::getItemStatusCodes() — Method in class KohaRest

Get statuses for an item

KohaRest::getStatusCodeItemCheckedOut() — Method in class KohaRest

Get item status code for CheckedOut status

KohaRest::getStatusCodeItemNotForLoanOrLost() — Method in class KohaRest

Get item status code for NotForLoan or Lost status

KohaRest::getStatusCodeItemTransfer() — Method in class KohaRest

Get item status code for Transfer status

KohaRest::getStatusRanking() — Method in class KohaRest

Support method for pickStatus() -- get the ranking value of the specified status message.

KohaRest::getLibraries() — Method in class KohaRest

Get libraries from cache or from the API

KohaRest::getLibraryName() — Method in class KohaRest

Get library name

KohaRest::getPatronBlocks() — Method in class KohaRest

Get patron's blocks, if any

KohaRest::getItem() — Method in class KohaRest

Fetch an item record from Koha

KohaRest::getBiblio() — Method in class KohaRest

Fetch a biblio record from Koha

KohaRest::getItemLocationName() — Method in class KohaRest

Return a location for a Koha item

KohaRest::getItemCallNumber() — Method in class KohaRest

Return a call number for a Koha item

KohaRest::getHoldBlockReason() — Method in class KohaRest

Get a reason for why a hold cannot be placed

KohaRest::getSortParamValue() — Method in class KohaRest

Converts given key to corresponding parameter

KohaRest::getBiblioTitle() — Method in class KohaRest

Get a complete title from all the title-related fields

KohaRest::getTransactions() — Method in class KohaRest

Get Patron Transactions

KohaRest::getPatronBlockReason() — Method in class KohaRest

Get a description for a block

MultiBackend::getStatus() — Method in class MultiBackend

Get Status

MultiBackend::getStatuses() — Method in class MultiBackend

Get Statuses

MultiBackend::getHolding() — Method in class MultiBackend

Get Holding

MultiBackend::getPurchaseHistory() — Method in class MultiBackend

Get Purchase History

MultiBackend::getLoginDrivers() — Method in class MultiBackend

Get available login targets (drivers enabled for login)

MultiBackend::getDefaultLoginDriver() — Method in class MultiBackend

Get default login driver

MultiBackend::getNewItems() — Method in class MultiBackend

Get New Items

MultiBackend::getDepartments() — Method in class MultiBackend

Get Departments

MultiBackend::getInstructors() — Method in class MultiBackend

Get Instructors

MultiBackend::getCourses() — Method in class MultiBackend

Get Courses

MultiBackend::getMyProfile() — Method in class MultiBackend

Get Patron Profile

MultiBackend::getMyHolds() — Method in class MultiBackend

Get Patron Holds

MultiBackend::getMyStorageRetrievalRequests() — Method in class MultiBackend

Get Patron Call Slips

MultiBackend::getPickUpLocations() — Method in class MultiBackend

Get Pick Up Locations

MultiBackend::getDefaultPickUpLocation() — Method in class MultiBackend

Get Default Pick Up Location

MultiBackend::getRequestGroups() — Method in class MultiBackend

Get request groups

MultiBackend::getDefaultRequestGroup() — Method in class MultiBackend

Get Default Request Group

MultiBackend::getCancelHoldDetails() — Method in class MultiBackend

Get Cancel Hold Details

MultiBackend::getILLPickupLibraries() — Method in class MultiBackend

Get ILL Pickup Libraries

MultiBackend::getILLPickupLocations() — Method in class MultiBackend

Get ILL Pickup Locations

MultiBackend::getMyILLRequests() — Method in class MultiBackend

Get Patron ILL Requests

MultiBackend::getRequestBlocks() — Method in class MultiBackend

Check whether the patron is blocked from placing requests (holds/ILL/SRR).

MultiBackend::getAccountBlocks() — Method in class MultiBackend

Check whether the patron has any blocks on their account.

MultiBackend::getConfig() — Method in class MultiBackend

Function which specifies renew, hold and cancel settings.

MultiBackend::getLocalId() — Method in class MultiBackend

Extract local ID from the given prefixed ID

MultiBackend::getSource() — Method in class MultiBackend

Extract source from the given ID

MultiBackend::getSourceForMethod() — Method in class MultiBackend

Get source for a method and parameters

MultiBackend::getSourceFromParams() — Method in class MultiBackend

Get source from method parameters

MultiBackend::getDriver() — Method in class MultiBackend

Find the correct driver for the correct configuration file for the given source and cache an initialized copy of it.

MultiBackend::getDriverConfig() — Method in class MultiBackend

Get configuration for the ILS driver. We will load an .ini file named after the driver class and number if it exists; otherwise we will return an empty array.

NewGenLib::getHolding() — Method in class NewGenLib

Get Holding

NewGenLib::getMyFines() — Method in class NewGenLib

Get Patron Fines

NewGenLib::getMyHolds() — Method in class NewGenLib

Get Patron Holds

NewGenLib::getMyProfile() — Method in class NewGenLib

Get Patron Profile

NewGenLib::getMyTransactions() — Method in class NewGenLib

Get Patron Transactions

NewGenLib::getStatus() — Method in class NewGenLib

Get Status

NewGenLib::getStatuses() — Method in class NewGenLib

Get Statuses

NewGenLib::getNewItems() — Method in class NewGenLib

Get New Items

NewGenLib::getPurchaseHistory() — Method in class NewGenLib

Get Purchase History

NewGenLib::getItemStatus() — Method in class NewGenLib

Support method to get information about the items attached to a record

NoILS::getConfig() — Method in class NoILS

Public Function which retrieves renew, hold and cancel settings from the driver ini file.

NoILS::getIdPrefix() — Method in class NoILS

Get the ID prefix from the configuration, if set.

NoILS::getSolrRecord() — Method in class NoILS

Get a Solr record.

NoILS::getStatus() — Method in class NoILS

Get Status

NoILS::getStatuses() — Method in class NoILS

Get Statuses

NoILS::getHolding() — Method in class NoILS

Get Holding

NoILS::getFormattedMarcDetails() — Method in class NoILS

This is responsible for retrieving the status or holdings information of a certain record from a Marc Record.

NoILS::getPurchaseHistory() — Method in class NoILS

Get Purchase History

NoILS::getNewItems() — Method in class NoILS

Get New Items

NoILS::getOfflineMode() — Method in class NoILS

Get Offline Mode

NoILS::getFunds() — Method in class NoILS

Get Funds

NoILS::getDepartments() — Method in class NoILS

Get Departments

NoILS::getInstructors() — Method in class NoILS

Get Instructors

NoILS::getCourses() — Method in class NoILS

Get Courses

OAuth2TokenTrait::getNewOAuth2Token() — Method in class OAuth2TokenTrait

Get new authorization token from API using given credentials

$ PAIA#grantTypeProperty in class PAIA

Accepted grant_type for authorization

PAIA::getCacheKey() — Method in class PAIA

PAIA specific override of method to ensure uniform cache keys for cached VuFind objects.

PAIA::getSession() — Method in class PAIA

Get the session container (constructing it on demand if not already present)

PAIA::getScope() — Method in class PAIA

Get the session scope

PAIA::getCancelHoldDetails() — Method in class PAIA

This method returns a string to use as the input form value for cancelling each hold item. (optional, but required if you implement cancelHolds). Not supported prior to VuFind 1.2

PAIA::getDefaultPickUpLocation() — Method in class PAIA

Get Default Pick Up Location

PAIA::getFunds() — Method in class PAIA

Get Funds

PAIA::getCancelStorageRetrievalRequestDetails() — Method in class PAIA

Get Cancel Storage Retrieval Request Details

PAIA::getMyILLRequests() — Method in class PAIA

Get Patron ILL Requests

PAIA::getILLPickupLibraries() — Method in class PAIA

Get ILL Pickup Libraries

PAIA::getILLPickupLocations() — Method in class PAIA

Get ILL Pickup Locations

PAIA::getCancelILLRequestDetails() — Method in class PAIA

Get Cancel ILL Request Details

PAIA::getMyFines() — Method in class PAIA

Get Patron Fines

PAIA::getAdditionalFeeData() — Method in class PAIA

Gets additional array fields for the item.

PAIA::getMyHolds() — Method in class PAIA

Get Patron Holds

PAIA::getMyProfile() — Method in class PAIA

Get Patron Profile

PAIA::getReadableGroupType() — Method in class PAIA

Get Readable Group Type

PAIA::getMyTransactions() — Method in class PAIA

Get Patron Transactions

PAIA::getMyStorageRetrievalRequests() — Method in class PAIA

Get Patron StorageRetrievalRequests

PAIA::getNewItems() — Method in class PAIA

This method queries the ILS for new items

PAIA::getPickUpLocations() — Method in class PAIA

Get Pick Up Locations

PAIA::getRenewDetails() — Method in class PAIA

This method returns a string to use as the input form value for renewing each hold item. (optional, but required if you implement the renewMyItems method) Not supported prior to VuFind 1.2

PAIA::getCallNumber() — Method in class PAIA

Get the callnumber of this item

PAIA::getConfirmations() — Method in class PAIA

Returns an array with PAIA confirmations based on the given holdDetails which will be used for a request.

PAIA::getAlternativeItemId() — Method in class PAIA

PAIA support method to retrieve needed ItemId in case PAIA-response does not contain it

PAIA::getBasicDetails() — Method in class PAIA

Map a PAIA document to an array for use in generating a VuFind request (holds, storage retrieval, etc).

PAIA::getPaiaNotificationsId() — Method in class PAIA

Get notification identifier from message identifier

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

Polaris::getMyHolds() — Method in class Polaris

Get Patron Holds

Polaris::getStatus() — Method in class Polaris

Get Status

Polaris::getStatuses() — Method in class Polaris

Get Statuses

Polaris::getConfig() — Method in class Polaris

Public Function which retrieves renew, hold and cancel settings from the driver ini file.

Polaris::getHolding() — Method in class Polaris

Get Holding

Polaris::getPickUpLocations() — Method in class Polaris

Get Pick Up Locations

Polaris::getDefaultPickUpLocation() — Method in class Polaris

Get Default Pick Up Location

Polaris::getPurchaseHistory() — Method in class Polaris

Get Purchase History

Polaris::getNewItems() — Method in class Polaris

Get New Items

Polaris::getMyFines() — Method in class Polaris

Get Patron Fines

Polaris::getMyProfile() — Method in class Polaris

Get Patron Profile

Polaris::getMyTransactions() — Method in class Polaris

Get Patron Transactions

Polaris::getRenewDetails() — Method in class Polaris

Get Renew Details

Polaris::getCancelHoldDetails() — Method in class Polaris

Get Cancel Hold Details

Polaris::getCheckoutHistory() — Method in class Polaris

Get Checkout History

Polaris::getHoldCount() — Method in class Polaris

Get Hold Count

Polaris::getSuspendHoldDetails() — Method in class Polaris

Get Suspend Hold Details

Sample::getStatus() — Method in class Sample

Get Status

Sample::getStatuses() — Method in class Sample

Get Statuses

Sample::getHolding() — Method in class Sample

Get Holding

Sample::getPurchaseHistory() — Method in class Sample

Get Purchase History

Sample::getNewItems() — Method in class Sample

Get New Items

Sierra::getIds() — Method in class Sierra

Uses the bib number in VuFind to look up the database ids for the associated items

Sierra::getLocationText() — Method in class Sierra

Modify location string to add status information, if necessary

Sierra::getCourses() — Method in class Sierra

Get Courses

Sierra::getDepartments() — Method in class Sierra

Get Departments

Sierra::getInstructors() — Method in class Sierra

Get Instructors

Sierra::getFunds() — Method in class Sierra

Get Funds

Sierra::getStatus() — Method in class Sierra

Get Status

Sierra::getHolding() — Method in class Sierra

Get Holding

Sierra::getNewItems() — Method in class Sierra

Get New Items

Sierra::getPurchaseHistory() — Method in class Sierra

Get Purchase History

Sierra::getStatuses() — Method in class Sierra

Get Statuses

Sierra::getSuppressedAuthorityRecords() — Method in class Sierra

Get suppressed authority records

Sierra::getSuppressedRecords() — Method in class Sierra

Get suppressed records.

SierraRest::getStatus() — Method in class SierraRest

Get Status

SierraRest::getStatuses() — Method in class SierraRest

Get Statuses

SierraRest::getHolding() — Method in class SierraRest

Get Holding

SierraRest::getPurchaseHistory() — Method in class SierraRest

Get Purchase History

SierraRest::getNewItems() — Method in class SierraRest

Get New Items

SierraRest::getRequestBlocks() — Method in class SierraRest

Check whether the patron is blocked from placing requests (holds/ILL/SRR).

SierraRest::getAccountBlocks() — Method in class SierraRest

Check whether the patron has any blocks on their account.

SierraRest::getMyProfile() — Method in class SierraRest

Get Patron Profile

SierraRest::getMyTransactions() — Method in class SierraRest

Get Patron Transactions

SierraRest::getRenewDetails() — Method in class SierraRest

Get Renew Details

SierraRest::getMyTransactionHistory() — Method in class SierraRest

Get Patron Transaction History

SierraRest::getMyHolds() — Method in class SierraRest

Get Patron Holds

SierraRest::getPickUpLocations() — Method in class SierraRest

Get Pick Up Locations

SierraRest::getDefaultPickUpLocation() — Method in class SierraRest

Get Default Pick Up Location

SierraRest::getMyFines() — Method in class SierraRest

Get Patron Fines

SierraRest::getConfig() — Method in class SierraRest

Public Function which retrieves renew, hold and cancel settings from the driver ini file.

SierraRest::getPatronAuthorizationCode() — Method in class SierraRest

Login and retrieve authorization code for the patron

SierraRest::getBibCallNumber() — Method in class SierraRest

Extract a bib call number from a bib record (if configured to do so).

SierraRest::getDueStatus() — Method in class SierraRest

Get due status for a checkout

SierraRest::getItemStatusesForBib() — Method in class SierraRest

Get Item Statuses

SierraRest::getHoldingsData() — Method in class SierraRest

Get holdings fields according to configuration

SierraRest::getLocationName() — Method in class SierraRest

Get name for a location code

SierraRest::getItemStatus() — Method in class SierraRest

Get status for an item

SierraRest::getPatronBlocks() — Method in class SierraRest

Get patron's blocks, if any

SierraRest::getBibRecord() — Method in class SierraRest

Fetch a bib record from Sierra

SierraRest::getPatronInformationFromAuthToken() — Method in class SierraRest

Get patron information via authentication token when using patron-specific access

SierraRest::getItemsWithBibsForTransactions() — Method in class SierraRest

Get items and their bibs for an array of transactions

Symphony::getSoapClient() — Method in class Symphony

Return a SoapClient for the specified SymWS service.

Symphony::getSoapHeader() — Method in class Symphony

Return a SoapHeader for the specified login and password.

Symphony::getSessionToken() — Method in class Symphony

Return a SymWS session token for given credentials.

Symphony::getStatuses999Holdings() — Method in class Symphony

Get Statuses from 999 Holdings Marc Tag

Symphony::getLiveStatuses() — Method in class Symphony

Get Live Statuses

Symphony::getStatus() — Method in class Symphony

Get Status

Symphony::getStatuses() — Method in class Symphony

Get Statuses

Symphony::getHolding() — Method in class Symphony

Get Holding

Symphony::getPurchaseHistory() — Method in class Symphony

Get Purchase History

Symphony::getMyProfile() — Method in class Symphony

Get Patron Profile

Symphony::getMyTransactions() — Method in class Symphony

Get Patron Transactions

Symphony::getMyHolds() — Method in class Symphony

Get Patron Holds

Symphony::getMyFines() — Method in class Symphony

Get Patron Fines

Symphony::getCancelHoldDetails() — Method in class Symphony

Get Cancel Hold Form

Symphony::getConfig() — Method in class Symphony

Public Function which retrieves renew, hold and cancel settings from the driver ini file.

Symphony::getRenewDetails() — Method in class Symphony

Get Renew Details

Symphony::getPolicyList() — Method in class Symphony

Get Policy List

Symphony::getPickUpLocations() — Method in class Symphony

Get Pick Up Locations

Symphony::getDefaultPickUpLocation() — Method in class Symphony

Get Default Pick Up Location

Unicorn::getConfig() — Method in class Unicorn

Public Function which retrieves renew, hold and cancel settings from the driver ini file.

Unicorn::getPickUpLocations() — Method in class Unicorn

Get Pick Up Locations

Unicorn::getDefaultPickUpLocation() — Method in class Unicorn

Get Default Pick Up Location

Unicorn::getRenewDetails() — Method in class Unicorn

Get Renew Details

Unicorn::getStatus() — Method in class Unicorn

Get Status

Unicorn::getStatuses() — Method in class Unicorn

Get Statuses

Unicorn::getPurchaseHistory() — Method in class Unicorn

Get Purchase History

Unicorn::getHolding() — Method in class Unicorn

Get Holding

Unicorn::getMyProfile() — Method in class Unicorn

Get Patron Profile

Unicorn::getMyFines() — Method in class Unicorn

Get Patron Fines

Unicorn::getMyHolds() — Method in class Unicorn

Get Patron Holds

Unicorn::getCancelHoldDetails() — Method in class Unicorn

Get Cancel Hold Details

Unicorn::getMyTransactions() — Method in class Unicorn

Get Patron Transactions

Unicorn::getCourses() — Method in class Unicorn

Get Courses

Unicorn::getInstructors() — Method in class Unicorn

Get Instructors

Unicorn::getDepartments() — Method in class Unicorn

Get Departments

Unicorn::getNewItems() — Method in class Unicorn

Get New Items

Unicorn::getSuppressedRecords() — Method in class Unicorn

Get suppressed records.

Unicorn::getMarcHoldings() — Method in class Unicorn

Get textual holdings summary.

Virtua::getStatus() — Method in class Virtua

Get Status

Virtua::getStatuses() — Method in class Virtua

Get Statuses

Virtua::getHolding() — Method in class Virtua

Get Holding

Virtua::getField() — Method in class Virtua

Simple utility -- retrieve data matching a code

Virtua::getPurchaseHistory() — Method in class Virtua

Get Purchase History

Virtua::getAll853() — Method in class Virtua

Used for TESTING only. Grabs all prediction patterns in the system for analysis

Virtua::getMyProfile() — Method in class Virtua

Get Patron Profile

Virtua::getMyFines() — Method in class Virtua

Get Patron Fines

Virtua::getMyHolds() — Method in class Virtua

Get Patron Holds

Virtua::getMyTransactions() — Method in class Virtua

Get Patron Transactions

Virtua::getCourses() — Method in class Virtua

Get Courses

Virtua::getOpeningHours() — Method in class Virtua

Retrieve the opening hours for all campuses.

Virtua::getCancelHoldDetails() — Method in class Virtua

Get Cancel Hold Details

Virtua::getRenewDetails() — Method in class Virtua

Get Renew Details

Virtua::getSuppressedAuthorityRecords() — Method in class Virtua

Get suppressed authority records

Virtua::getApiBaseUrl() — Method in class Virtua

Support method -- get base URL for API requests.

Virtua::getConfiguredLanguage() — Method in class Virtua

Support method -- determine the language from the configuration.

Voyager::getDb() — Method in class Voyager

Initialize database connection if necessary and return it.

Voyager::getStatusRanking() — Method in class Voyager

Support method for pickStatus() -- get the ranking value of the specified status message.

Voyager::getItemSortSequenceSQL() — Method in class Voyager

Helper function that returns SQL for getting a sort sequence for a location

Voyager::getStatusSQL() — Method in class Voyager

Protected support method for getStatus -- get components required for standard status lookup SQL.

Voyager::getStatusNoItemsSQL() — Method in class Voyager

Protected support method for getStatus -- get components for status lookup SQL to use when a bib record has no items.

Voyager::getStatusData() — Method in class Voyager

Protected support method for getStatus -- process rows returned by SQL lookup.

Voyager::getStatus() — Method in class Voyager

Get Status

Voyager::getStatuses() — Method in class Voyager

Get Statuses

Voyager::getHoldingItemsSQL() — Method in class Voyager

Protected support method for getHolding.

Voyager::getHoldingNoItemsSQL() — Method in class Voyager

Protected support method for getHolding.

Voyager::getHoldingData() — Method in class Voyager

Protected support method for getHolding.

Voyager::getPurchaseHistoryData() — Method in class Voyager

Get Purchase History Data

Voyager::getMFHDData() — Method in class Voyager

Get specified fields from an MFHD MARC Record

Voyager::getLocationName() — Method in class Voyager

Look up a location name by ID.

Voyager::getHolding() — Method in class Voyager

Get Holding

Voyager::getPurchaseHistory() — Method in class Voyager

Get Purchase History

Voyager::getMyTransactionsSQL() — Method in class Voyager

Protected support method for getMyTransactions.

Voyager::getMyTransactions() — Method in class Voyager

Get Patron Transactions

Voyager::getFineSQL() — Method in class Voyager

Protected support method for getMyFines.

Voyager::getMyFines() — Method in class Voyager

Get Patron Fines

Voyager::getMyHoldsSQL() — Method in class Voyager

Protected support method for getMyHolds.

Voyager::getMyHolds() — Method in class Voyager

Get Patron Holds

Voyager::getMyStorageRetrievalRequestsSQL() — Method in class Voyager

Protected support method for getMyStorageRetrievalRequests.

Voyager::getMyStorageRetrievalRequests() — Method in class Voyager

Get Patron Storage Retrieval Requests

Voyager::getMyProfile() — Method in class Voyager

Get Patron Profile

Voyager::getHoldLink() — Method in class Voyager

Get Hold Link

Voyager::getNewItems() — Method in class Voyager

Get New Items

Voyager::getFunds() — Method in class Voyager

Get Funds

Voyager::getDepartments() — Method in class Voyager

Get Departments

Voyager::getInstructors() — Method in class Voyager

Get Instructors

Voyager::getCourses() — Method in class Voyager

Get Courses

Voyager::getRecentlyReturnedBibs() — Method in class Voyager

Get bib records for recently returned items.

Voyager::getTrendingBibs() — Method in class Voyager

Get bib records for "trending" items (recently returned with high usage).

Voyager::getSuppressedRecords() — Method in class Voyager

Get suppressed records.

VoyagerRestful::getConfig() — Method in class VoyagerRestful

Public Function which retrieves renew, hold and cancel settings from the driver ini file.

VoyagerRestful::getCacheKey() — Method in class VoyagerRestful

Add instance-specific context to a cache key suffix (to ensure that multiple drivers don't accidentally share values in the cache.

VoyagerRestful::getHoldingItemsSQL() — Method in class VoyagerRestful

Protected support method for getHolding.

VoyagerRestful::getPickUpLocations() — Method in class VoyagerRestful

Get Pick Up Locations

VoyagerRestful::getDefaultPickUpLocation() — Method in class VoyagerRestful

Get Default Pick Up Location

VoyagerRestful::getDefaultRequestGroup() — Method in class VoyagerRestful

Get Default Request Group

VoyagerRestful::getRequestGroups() — Method in class VoyagerRestful

Get request groups

VoyagerRestful::getRequestBlocks() — Method in class VoyagerRestful

Check whether the patron is blocked from placing requests (holds/ILL/SRR).

VoyagerRestful::getAccountBlocks() — Method in class VoyagerRestful

Check whether the patron has any blocks on their account.

VoyagerRestful::getMyHoldsSQL() — Method in class VoyagerRestful

Protected support method for getMyHolds.

VoyagerRestful::getMyHolds() — Method in class VoyagerRestful

Get Patron Holds

VoyagerRestful::getCancelHoldDetails() — Method in class VoyagerRestful

Get Cancel Hold Details

VoyagerRestful::getRenewDetails() — Method in class VoyagerRestful

Get Renew Details

VoyagerRestful::getMyTransactions() — Method in class VoyagerRestful

Get Patron Transactions

VoyagerRestful::getHoldsFromApi() — Method in class VoyagerRestful

Get patron's local or remote holds from the API

VoyagerRestful::getCallSlips() — Method in class VoyagerRestful

Get Patron Storage Retrieval Requests (Call Slips). Gets callslips via the API. Returns only remote slips by default since more complete data can be retrieved directly from the local database; however, the $local parameter exists to support potential local customizations.

VoyagerRestful::getCancelStorageRetrievalRequestDetails() — Method in class VoyagerRestful

Get Cancel Storage Retrieval Request (Call Slip) Details

VoyagerRestful::getUBRequestDetails() — Method in class VoyagerRestful

A helper function that retrieves UB request details for ILL and caches them for a short while for faster access.

VoyagerRestful::getILLPickupLibraries() — Method in class VoyagerRestful

Get ILL (UB) Pickup Libraries

VoyagerRestful::getILLPickupLocations() — Method in class VoyagerRestful

Get ILL (UB) Pickup Locations

VoyagerRestful::getMyILLRequests() — Method in class VoyagerRestful

Get Patron ILL Requests

VoyagerRestful::getCancelILLRequestDetails() — Method in class VoyagerRestful

Get Cancel ILL (UB) Request Details

XCNCIP2::getOAuth2Token() — Method in class XCNCIP2

Get a new or cached OAuth2 token (type + token)

XCNCIP2::getCacheKey() — Method in class XCNCIP2

Method to ensure uniform cache keys for cached VuFind objects.

XCNCIP2::getStatusForChunk() — Method in class XCNCIP2

Given a chunk of the availability response, extract the values needed by VuFind.

XCNCIP2::getHoldingsForChunk() — Method in class XCNCIP2

Given a chunk of the availability response, extract the values needed by VuFind.

XCNCIP2::getStatus() — Method in class XCNCIP2

Get Status

XCNCIP2::getStatusRequest() — Method in class XCNCIP2

Build NCIP2 request XML for item status information.

XCNCIP2::getStatuses() — Method in class XCNCIP2

Get Statuses

XCNCIP2::getConsortialHoldings() — Method in class XCNCIP2

Get Consortial Holding

XCNCIP2::getHolding() — Method in class XCNCIP2

Get Holding

XCNCIP2::getPurchaseHistory() — Method in class XCNCIP2

Get Purchase History

XCNCIP2::getMyTransactions() — Method in class XCNCIP2

Get Patron Transactions

XCNCIP2::getMyFines() — Method in class XCNCIP2

Get Patron Fines

XCNCIP2::getMyRequests() — Method in class XCNCIP2

Get Patron requests by type

XCNCIP2::getMyHolds() — Method in class XCNCIP2

Get Patron Holds

XCNCIP2::getMyProfile() — Method in class XCNCIP2

Get Patron Profile

XCNCIP2::getNewItems() — Method in class XCNCIP2

Get New Items

XCNCIP2::getFunds() — Method in class XCNCIP2

Get Funds

XCNCIP2::getDepartments() — Method in class XCNCIP2

Get Departments

XCNCIP2::getInstructors() — Method in class XCNCIP2

Get Instructors

XCNCIP2::getCourses() — Method in class XCNCIP2

Get Courses

XCNCIP2::getSuppressedRecords() — Method in class XCNCIP2

Get suppressed records.

XCNCIP2::getConfig() — Method in class XCNCIP2

Public Function which retrieves Holds, StorageRetrivalRequests, and Consortial settings from the driver ini file.

XCNCIP2::getDefaultPickUpLocation() — Method in class XCNCIP2

Get Default Pick Up Location

XCNCIP2::getPatronBlocks() — Method in class XCNCIP2

Return patron blocks

XCNCIP2::getPickUpLocations() — Method in class XCNCIP2

Get Pick Up Locations

XCNCIP2::getMyStorageRetrievalRequests() — Method in class XCNCIP2

Get Patron Storage Retrieval Requests

XCNCIP2::getRenewDetails() — Method in class XCNCIP2

Get Renew Details

XCNCIP2::getCancelRequestDetails() — Method in class XCNCIP2

Get Cancel Request Details

XCNCIP2::getCancelHoldDetails() — Method in class XCNCIP2

Get Cancel Hold Details

XCNCIP2::getCancelStorageRetrievalRequestDetails() — Method in class XCNCIP2

Get Cancel Storage Retrieval Request (Call Slip) Details

XCNCIP2::getAccountBlocks() — Method in class XCNCIP2

Check whether the patron has any blocks on their account.

XCNCIP2::getCancelRequest() — Method in class XCNCIP2

Helper function to build the request XML to cancel a request:

XCNCIP2::getRequest() — Method in class XCNCIP2

Helper function to build the request XML to request an item (Hold, Storage Retrieval, etc)

XCNCIP2::getRenewRequest() — Method in class XCNCIP2

Helper function to build the request XML to renew an item:

XCNCIP2::getLookupUserRequest() — Method in class XCNCIP2

Helper function to build the request XML to log in a user and/or retrieve loaned items / request information

XCNCIP2::getLookupAgencyRequest() — Method in class XCNCIP2

Get LookupAgency Request XML message

XCNCIP2::getLookupItemRequest() — Method in class XCNCIP2

Create Lookup Item Request

XCNCIP2::getInitiationHeaderXml() — Method in class XCNCIP2

Get InitiationHeader element XML string

XCNCIP2::getNCIPMessageStart() — Method in class XCNCIP2

Helper method for creating XML header and main element start

XCNCIP2::getAuthenticationInputXml() — Method in class XCNCIP2

Get XML string for AuthenticationInput element

XCNCIP2::getItemIdXml() — Method in class XCNCIP2

Get ItemId element XML

XCNCIP2::getUserIdXml() — Method in class XCNCIP2

Get UserId element XML

XCNCIP2::getRequestTypeXml() — Method in class XCNCIP2

Get request type elements XML

XCNCIP2::getBibliographicId() — Method in class XCNCIP2

Get BibliographicId element

XCNCIP2::getHoldType() — Method in class XCNCIP2

Get Hold Type

XCNCIP2::getLookupUserResponse() — Method in class XCNCIP2

Get Lookup user response

XCNCIP2::getLookupUserExtras() — Method in class XCNCIP2

Creates array for Lookup user desired information

XCNCIP2::getProblemDescription() — Method in class XCNCIP2

Get problem description as one string

XCNCIP2::getBibs() — Method in class XCNCIP2

Get all bibliographic records

HoldSettings::getHoldsMode() — Method in class HoldSettings

Get Holds Mode

HoldSettings::getTitleHoldsMode() — Method in class HoldSettings

Get Title Holds Mode

Holds::getHoldings() — Method in class Holds

Public method for getting item holdings from the catalog and selecting which holding method to call

Holds::generateHoldings() — Method in class Holds

Protected method for vufind (i.e. User) defined holdings

Holds::getRequestDetails() — Method in class Holds

Get Hold Form

Holds::getHoldingsGroupKey() — Method in class Holds

Get a grouping key for a holdings item

Holds::getSuppressedLocations() — Method in class Holds

Get an array of suppressed location names.

TitleHolds::getHold() — Method in class TitleHolds

Public method for getting title level holds

TitleHolds::getHoldings() — Method in class TitleHolds

Get holdings for a particular record.

TitleHolds::generateHold() — Method in class TitleHolds

Protected method for vufind (i.e. User) defined holds

TitleHolds::getHoldDetails() — Method in class TitleHolds

Get Hold Link

PaginationHelper::getSortList() — Method in class PaginationHelper

Support method for getPagingSetup() -- determine the list of sort options.

PaginationHelper::getOptions() — Method in class PaginationHelper

Get paging settings and request data for paged ILS requests.

PaginationHelper::getPaginator() — Method in class PaginationHelper

Build a paginator with the paging options and ILS results if necessary

ImageLoader::getImage() — Method in class ImageLoader

Get the image data (not meant to be called until after image is populated)

ImageLoader::getContentType() — Method in class ImageLoader

Get the content type of the current image (not meant to be called until after contentType is populated)

ImageLoader::getContentTypeFromExtension() — Method in class ImageLoader

Get the content-type for a file based on extension. Throw an exception if an illegal extension is provided.

Logger::getSeverityFromException() — Method in class Logger

Given an exception, return a severity level for logging purposes.

Office365::getBody() — Method in class Office365

Get data for raw body

Post::getBody() — Method in class Post

Get data for raw body

Slack::getBody() — Method in class Slack

Get data for raw body

Factory::getTransport() — Method in class Factory

Build the mail transport object.

Mailer::getTransport() — Method in class Mailer

Get the mail transport object.

Mailer::getNewMessage() — Method in class Mailer

Get a text email message object.

Mailer::getNewBlankMessage() — Method in class Mailer

Get a blank email message object.

Mailer::getDefaultLinkSubject() — Method in class Mailer

Get the default subject line for sendLink().

Mailer::getDefaultRecordSubject() — Method in class Mailer

Get the default subject line for sendRecord()

Mailer::getFromAddressOverride() — Method in class Mailer

Get the "From" address override value

AbstractBase::getGenericData() — Method in class AbstractBase

Generate standardized data from available RecordDriver methods

AbstractBase::getMappedData() — Method in class AbstractBase

Perform mapping from generic data to vocabulary data

Eprints::getMappedData() — Method in class Eprints

Special implementation to combine start / end page in eprints.pagerange

HighwirePress::getMappedData() — Method in class HighwirePress

Special implementation for date formats

MetadataVocabularyInterface::getMappedData() — Method in class MetadataVocabularyInterface

Map data from RecordDriver to this vocabulary.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the base class or interface that plug-ins must conform to.

Module::getConfig() — Method in class Module

Get module configuration

Module::getAutoloaderConfig() — Method in class Module

Get autoloader configuration

UserIpReader::getUserIp() — Method in class UserIpReader

Get the active user's IP address. Returns null if no address can be found.

Server::getUTCDateTime() — Method in class Server

Get the current UTC date/time in ISO 8601 format.

Server::getResponse() — Method in class Server

Respond to the OAI-PMH request.

Server::getVuFindMetadata() — Method in class Server

Support method for attachNonDeleted() to build the VuFind metadata for a record driver.

Server::getRecord() — Method in class Server

Respond to a GetRecord request.

Server::getMetadataFormats() — Method in class Server

Get metadata formats; initialize the list if necessary.

ScopeEntity::getDescription() — Method in class ScopeEntity

Get description

ScopeEntity::getHidden() — Method in class ScopeEntity

Get hidden flag

ScopeEntity::getILSNeeded() — Method in class ScopeEntity

Get ILS needed flag

UserEntity::getClaims() — Method in class UserEntity

Get claims (attributes) for OpenID Connect

AbstractTokenRepository::getNew() — Method in class AbstractTokenRepository

Get a new token

AccessTokenRepository::getNewToken() — Method in class AccessTokenRepository

Create a new access token

AuthCodeRepository::getNewAuthCode() — Method in class AuthCodeRepository

Create a new authentication code

ClientRepository::getClientEntity() — Method in class ClientRepository

Get a client.

IdentityRepository::getUserEntityByIdentifier() — Method in class IdentityRepository

Get a user entity by identifier.

RefreshTokenRepository::getNewRefreshToken() — Method in class RefreshTokenRepository

Create a new refresh token

ScopeRepository::getScopeEntityByIdentifier() — Method in class ScopeRepository

Return information about a scope.

Loader::getDefaults() — Method in class Loader

Get default parameters.

AbstractFacets::getFacetOperator() — Method in class AbstractFacets

Get the facet boolean operator

AbstractFacets::getResults() — Method in class AbstractFacets

Get results stored in the object.

AbstractResultsPassthrough::getResults() — Method in class AbstractResultsPassthrough

Get results stored in the object.

AbstractSummonRecommend::getResults() — Method in class AbstractSummonRecommend

Get specific results needed by template.

AbstractSummonRecommendDeferred::getUrlParams() — Method in class AbstractSummonRecommendDeferred

Get the URL parameters needed to make the AJAX recommendation request.

AlphaBrowseLink::getQuery() — Method in class AlphaBrowseLink

Get the search query.

AlphaBrowseLink::getIndex() — Method in class AlphaBrowseLink

Get the alphabrowse index to link to

AuthorFacets::getResults() — Method in class AuthorFacets

Get results stored in the object.

AuthorFacets::getSearchTerm() — Method in class AuthorFacets

Returns search term.

AuthorFacets::getSimilarAuthors() — Method in class AuthorFacets

Process similar authors from an author search

AuthorInfo::getAuthorInfo() — Method in class AuthorInfo

Returns info from Wikipedia to the view

AuthorInfo::getWikipediaNameFromViaf() — Method in class AuthorInfo

Translate an LCCN to a Wikipedia name through the VIAF web service. Returns false if no value can be found.

AuthorInfo::getAuthor() — Method in class AuthorInfo

Takes the search term and extracts a normal name from it

AuthorityRecommend::getHeader() — Method in class AuthorityRecommend

Get the header to display in the user interface.

AuthorityRecommend::getRecommendations() — Method in class AuthorityRecommend

Get recommendations (for use in the view).

AuthorityRecommend::getResults() — Method in class AuthorityRecommend

Get results stored in the object.

CatalogResults::getSearchClassId() — Method in class CatalogResults

Get the search class ID to use for building search objects.

CollectionSideFacets::getKeywordFilter() — Method in class CollectionSideFacets

Get the current value of the keyword filter.

DOI::getDOI() — Method in class DOI

Get the matched DOI (or null if no match found)

DOI::getURL() — Method in class DOI

Get the URL to resolve the matched DOI (or null if no match found)

DPLATerms::getResults() — Method in class DPLATerms

Get terms related to the query.

DPLATerms::getApiInput() — Method in class DPLATerms

Get input parameters for API call.

EDSResults::getSearchClassId() — Method in class EDSResults

Get the search class ID to use for building search objects.

EDSResultsDeferred::getUrlParams() — Method in class EDSResultsDeferred

Get the URL parameters needed to make the AJAX recommendation request.

EuropeanaResults::getURL() — Method in class EuropeanaResults

Build the url which will be send to retrieve the RSS results

EuropeanaResults::getResults() — Method in class EuropeanaResults

Get the results of the query (false if none).

EuropeanaResultsDeferred::getUrlParams() — Method in class EuropeanaResultsDeferred

Get the URL parameters needed to make the AJAX recommendation request.

ExpandFacets::getExpandedSet() — Method in class ExpandFacets

Get the facet data

ExpandFacets::getEmptyResults() — Method in class ExpandFacets

Get an empty search object (the template uses this as the basis for URL generation).

ExternalSearch::getLinkText() — Method in class ExternalSearch

Get the link text.

ExternalSearch::getUrl() — Method in class ExternalSearch

Get the link URL.

FacetCloud::getFacetLimit() — Method in class FacetCloud

Get the facet limit.

Libraryh3lp::getChatId() — Method in class Libraryh3lp

Get queue name

Libraryh3lp::getSkin() — Method in class Libraryh3lp

Get skin number

$ MapSelection#geoFieldProperty in class MapSelection

The geoField variable name

MapSelection::getSelectedCoordinates() — Method in class MapSelection
GetSelectedCoordinates
MapSelection::getDefaultCoordinates() — Method in class MapSelection
GetDefaultCoordinates
MapSelection::getBasemap() — Method in class MapSelection

Get the basemap configuration settings.

MapSelection::getHeight() — Method in class MapSelection
GetHeight
MapSelection::getSearchParams() — Method in class MapSelection
GetSearchParams
MapSelection::getGeoField() — Method in class MapSelection
GetGeoField
MapSelection::getSearchResultCoordinates() — Method in class MapSelection

Get geo field values for all search results

MapSelection::getMapResultCoordinates() — Method in class MapSelection

Process search result record coordinate values for Leaflet mapping platform.

OpenLibrarySubjects::getPublishedDates() — Method in class OpenLibrarySubjects

Support function to get publication date range. Return string in the form "YYYY-YYYY"

OpenLibrarySubjects::getResult() — Method in class OpenLibrarySubjects

Get the results of the subject query -- false if none, otherwise an array with 'worksArray' and 'subject' keys.

OpenLibrarySubjectsDeferred::getUrlParams() — Method in class OpenLibrarySubjectsDeferred

Get the URL parameters needed to make the AJAX recommendation request.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

PubDateVisAjax::getVisFacets() — Method in class PubDateVisAjax

Get visual facet details.

PubDateVisAjax::getZooming() — Method in class PubDateVisAjax

Get zoom setting

PubDateVisAjax::getFacetFields() — Method in class PubDateVisAjax

Get facet fields

PubDateVisAjax::getSearchParams() — Method in class PubDateVisAjax

Get search parameters

RandomRecommend::getResults() — Method in class RandomRecommend

Get Results

RandomRecommend::getDisplayMode() — Method in class RandomRecommend

Get Display Mode

RecommendLinks::getLinks() — Method in class RecommendLinks

Get array of links with title as key and value as link

RemoveFilters::getFilterlessUrl() — Method in class RemoveFilters

Get the URL for this query without filters.

RemoveFilters::getActiveFacetsCount() — Method in class RemoveFilters

Get the new search handler, or false if it does not apply.

SearchObject::getResults() — Method in class SearchObject

Get search results.

SearchObject::getSearchClassId() — Method in class SearchObject

Get the search class ID to use for building search objects.

$ SideFacets#genericRangeFacetsProperty in class SideFacets

Generic range facet configuration

SideFacets::getCheckboxFacetSet() — Method in class SideFacets

Get checkbox facet information from the search results.

SideFacets::getFacetSet() — Method in class SideFacets

Get facet information from the search results.

SideFacets::getDateFacets() — Method in class SideFacets

Return year-based date facet information in a format processed for use in the view.

SideFacets::getFullDateFacets() — Method in class SideFacets

Return year/month/day-based date facet information in a format processed for use in the view.

SideFacets::getGenericRangeFacets() — Method in class SideFacets

Return generic range facet information in a format processed for use in the view.

SideFacets::getNumericRangeFacets() — Method in class SideFacets

Return numeric range facet information in a format processed for use in the view.

SideFacets::getAllRangeFacets() — Method in class SideFacets

Get combined range details.

SideFacets::getCollapsedFacets() — Method in class SideFacets

Return the list of facets configured to be collapsed

SideFacets::getShowMoreSetting() — Method in class SideFacets

Return the list of facets configured to be collapsed defaults to 6

SideFacets::getShowInLightboxSetting() — Method in class SideFacets

Return settings for showing more results in the lightbox

SideFacets::getRangeFacets() — Method in class SideFacets

Return range facet information in a format processed for use in the view.

SideFacets::getHierarchicalFacets() — Method in class SideFacets

Return the list of facets configured to be hierarchical

SideFacets::getHierarchicalFacetSortOptions() — Method in class SideFacets

Return the list of configured hierarchical facet sort options

SideFacetsDeferred::getResults() — Method in class SideFacetsDeferred

Get results stored in the object.

SideFacetsDeferred::getActiveFacets() — Method in class SideFacetsDeferred

Get active facets (key => display string)

SummonBestBets::getResults() — Method in class SummonBestBets

Get best bets results.

SummonDatabases::getResults() — Method in class SummonDatabases

Get database results.

SummonResults::getSearchClassId() — Method in class SummonResults

Get the search class ID to use for building search objects.

SummonResultsDeferred::getUrlParams() — Method in class SummonResultsDeferred

Get the URL parameters needed to make the AJAX recommendation request.

SummonTopics::getResults() — Method in class SummonTopics

Get topic results.

SwitchQuery::getLuceneHelper() — Method in class SwitchQuery

Extract a Lucene syntax helper from the search backend, if possible.

SwitchQuery::getResults() — Method in class SwitchQuery

Get results stored in the object.

SwitchQuery::getSuggestions() — Method in class SwitchQuery

Get an array of suggestion messages.

SwitchTab::getActiveTab() — Method in class SwitchTab

Get the active tab.

SwitchTab::getInactiveTabs() — Method in class SwitchTab

Get the other (inactive) tabs.

SwitchType::getResults() — Method in class SwitchType

Get results stored in the object.

SwitchType::getNewHandler() — Method in class SwitchType

Get the new search handler, or false if it does not apply.

SwitchType::getNewHandlerName() — Method in class SwitchType

Get the description of the new search handler.

TopFacets::getTopFacetSet() — Method in class TopFacets

Get facet information taken from the search.

TopFacets::getTopFacetSettings() — Method in class TopFacets

Get configuration settings related to top facets.

VisualFacets::getPivotFacetSet() — Method in class VisualFacets

Get facet information taken from the search.

WebResults::getSearchClassId() — Method in class WebResults

Get the search class ID to use for building search objects.

WorldCatIdentities::getIdentities() — Method in class WorldCatIdentities

Get identities related to the query.

AbstractBase::getRawData() — Method in class AbstractBase

Retrieve raw data from object (primarily for use in staff view and autocomplete; avoid using whenever possible).

AbstractBase::getBreadcrumb() — Method in class AbstractBase

Get text that can be displayed to represent this record in breadcrumbs.

AbstractBase::getUniqueID() — Method in class AbstractBase

Return the unique identifier of this record for retrieving additional information (like tags and user comments) from the external MySQL database.

AbstractBase::getComments() — Method in class AbstractBase

Get comments associated with this record.

AbstractBase::getSortTitle() — Method in class AbstractBase

Get a sortable title for the record (i.e. no leading articles).

AbstractBase::getTags() — Method in class AbstractBase

Get tags associated with this record.

AbstractBase::getRatingData() — Method in class AbstractBase

Get rating information for this record.

AbstractBase::getRatingBreakdown() — Method in class AbstractBase

Get rating breakdown for this record.

AbstractBase::getListNotes() — Method in class AbstractBase

Get notes associated with this record in user lists.

AbstractBase::getContainingLists() — Method in class AbstractBase

Get a list of lists containing this record.

AbstractBase::getCitationFormats() — Method in class AbstractBase

Get an array of supported, user-activated citation formats.

AbstractBase::getSupportedCitationFormats() — Method in class AbstractBase

Get an array of strings representing citation formats supported by this record's data (empty if none). For possible legal values, see /application/themes/root/helpers/Citation.php.

AbstractBase::getExtraDetail() — Method in class AbstractBase

Retrieve a piece of supplemental information stored using setExtraDetail().

BrowZine::getShortTitle() — Method in class BrowZine

Get the short (pre-subtitle) title of the record.

BrowZine::getSjrValue() — Method in class BrowZine

Get the SciMago Journal Rank

BrowZine::getTitle() — Method in class BrowZine

Get the full title of the record.

BrowZine::getThumbnail() — Method in class BrowZine

Returns one of three things: a full URL to a thumbnail preview of the record if an image is available in an external system; an array of parameters to send to VuFind's internal cover generator if no fixed URL exists; or false if no thumbnail can be generated.

BrowZine::getISSNs() — Method in class BrowZine

Get an array of all ISSNs associated with the record (may be empty).

BrowZine::getURLs() — Method in class BrowZine

Return an array of associative URL arrays with one or more of the following keys:

DefaultRecord::getAccessRestrictions() — Method in class DefaultRecord

Get access restriction notes for the record.

DefaultRecord::getAllSubjectHeadings() — Method in class DefaultRecord

Get all subject headings associated with this record. Each heading is returned as an array of chunks, increasing from least specific to most specific.

DefaultRecord::getAllRecordLinks() — Method in class DefaultRecord

Get all record links related to the current record. Each link is returned as array.

DefaultRecord::getAuthorDataFields() — Method in class DefaultRecord

Get Author Information with Associated Data Fields

DefaultRecord::getAwards() — Method in class DefaultRecord

Get award notes for the record.

DefaultRecord::getBibliographyNotes() — Method in class DefaultRecord

Get notes on bibliography content.

DefaultRecord::getBreadcrumb() — Method in class DefaultRecord

Get text that can be displayed to represent this record in breadcrumbs.

DefaultRecord::getCallNumber() — Method in class DefaultRecord

Get the first call number associated with the record (empty string if none).

DefaultRecord::getCallNumbers() — Method in class DefaultRecord

Get all call numbers associated with the record.

DefaultRecord::getCleanDOI() — Method in class DefaultRecord

Return the first valid DOI found in the record (false if none).

DefaultRecord::getCleanISBN() — Method in class DefaultRecord

Return the first valid ISBN found in the record (favoring ISBN-10 over ISBN-13 when possible).

DefaultRecord::getCleanISSN() — Method in class DefaultRecord

Get just the base portion of the first listed ISSN (or false if no ISSNs).

DefaultRecord::getCleanOCLCNum() — Method in class DefaultRecord

Get just the first listed OCLC Number (or false if none available).

DefaultRecord::getCleanUPC() — Method in class DefaultRecord

Get just the first listed UPC Number (or false if none available).

DefaultRecord::getCleanNBN() — Method in class DefaultRecord

Get just the first listed national bibliography number (or false if none available).

DefaultRecord::getCleanISMN() — Method in class DefaultRecord

Get just the base portion of the first listed ISMN (or false if no ISSMs).

DefaultRecord::getCorporateAuthors() — Method in class DefaultRecord

Get the main corporate authors (if any) for the record.

DefaultRecord::getCorporateAuthorsRoles() — Method in class DefaultRecord

Get an array of all main corporate authors roles.

DefaultRecord::getDateSpan() — Method in class DefaultRecord

Get the date coverage for a record which spans a period of time (i.e. a journal). Use getPublicationDates for publication dates of particular monographic items.

DefaultRecord::getDeduplicatedAuthors() — Method in class DefaultRecord

Deduplicate author information into associative array with main/corporate/ secondary keys.

DefaultRecord::getEdition() — Method in class DefaultRecord

Get the edition of the current record.

DefaultRecord::getFindingAids() — Method in class DefaultRecord

Get notes on finding aids related to the record.

DefaultRecord::getFormats() — Method in class DefaultRecord

Get an array of all the formats associated with the record.

DefaultRecord::getGeneralNotes() — Method in class DefaultRecord

Get general notes on the record.

DefaultRecord::getRawAuthorHighlights() — Method in class DefaultRecord

Get highlighted author data, if available.

DefaultRecord::getPrimaryAuthorsWithHighlighting() — Method in class DefaultRecord

Get primary author information with highlights applied (if applicable)

DefaultRecord::getLastIndexed() — Method in class DefaultRecord

Get a string representing the last date that the record was indexed.

DefaultRecord::getSnippetCaption() — Method in class DefaultRecord

Given a field name, return an appropriate caption.

DefaultRecord::getHighlightedSnippet() — Method in class DefaultRecord

Pick one line from the highlighted text (if any) to use as a snippet.

DefaultRecord::getHighlightedTitle() — Method in class DefaultRecord

Get a highlighted title string, if available.

DefaultRecord::getInstitutions() — Method in class DefaultRecord

Get the institutions holding the record.

DefaultRecord::getBuildings() — Method in class DefaultRecord

Get the buildings containing the record.

DefaultRecord::getISBNs() — Method in class DefaultRecord

Get an array of all ISBNs associated with the record (may be empty).

DefaultRecord::getISSNs() — Method in class DefaultRecord

Get an array of all ISSNs associated with the record (may be empty).

DefaultRecord::getLanguages() — Method in class DefaultRecord

Get an array of all the languages associated with the record.

DefaultRecord::getRawLCCN() — Method in class DefaultRecord

Get a raw, unnormalized LCCN. (See getLCCN for normalization).

DefaultRecord::getLCCN() — Method in class DefaultRecord

Get a LCCN, normalised according to info:lccn

DefaultRecord::getNewerTitles() — Method in class DefaultRecord

Get an array of newer titles for the record.

DefaultRecord::getOCLC() — Method in class DefaultRecord

Get the OCLC number(s) of the record.

DefaultRecord::getOpenUrlFormat() — Method in class DefaultRecord

Support method for getOpenUrl() -- pick the OpenURL format.

DefaultRecord::getCoinsID() — Method in class DefaultRecord

Get the COinS identifier.

DefaultRecord::getDefaultOpenUrlParams() — Method in class DefaultRecord

Get default OpenURL parameters.

DefaultRecord::getBookOpenUrlParams() — Method in class DefaultRecord

Get OpenURL parameters for a book.

DefaultRecord::getArticleOpenUrlParams() — Method in class DefaultRecord

Get OpenURL parameters for an article.

DefaultRecord::getUnknownFormatOpenUrlParams() — Method in class DefaultRecord

Get OpenURL parameters for an unknown format.

DefaultRecord::getJournalOpenUrlParams() — Method in class DefaultRecord

Get OpenURL parameters for a journal.

DefaultRecord::getOpenUrl() — Method in class DefaultRecord

Get the OpenURL parameters to represent this record (useful for the title attribute of a COinS span tag).

DefaultRecord::getCoinsOpenUrl() — Method in class DefaultRecord

Get the OpenURL parameters to represent this record for COinS even if supportsOpenUrl() is false for this RecordDriver.

DefaultRecord::getPhysicalDescriptions() — Method in class DefaultRecord

Get an array of physical descriptions of the item.

DefaultRecord::getPlacesOfPublication() — Method in class DefaultRecord

Get the item's place of publication.

DefaultRecord::getPlayingTimes() — Method in class DefaultRecord

Get an array of playing times for the record (if applicable).

DefaultRecord::getPreviousTitles() — Method in class DefaultRecord

Get an array of previous titles for the record.

DefaultRecord::getPrimaryAuthor() — Method in class DefaultRecord

Get the main author of the record.

DefaultRecord::getPrimaryAuthors() — Method in class DefaultRecord

Get the main authors of the record.

DefaultRecord::getPrimaryAuthorsRoles() — Method in class DefaultRecord

Get an array of all main authors roles (complementing getSecondaryAuthorsRoles()).

DefaultRecord::getProductionCredits() — Method in class DefaultRecord

Get credits of people involved in production of the item.

DefaultRecord::getPublicationDates() — Method in class DefaultRecord

Get the publication dates of the record. See also getDateSpan().

DefaultRecord::getHumanReadablePublicationDates() — Method in class DefaultRecord

Get human readable publication dates for display purposes (may not be suitable for computer processing -- use getPublicationDates() for that).

DefaultRecord::getPublicationDetails() — Method in class DefaultRecord

Get an array of publication detail lines combining information from getPublicationDates(), getPublishers() and getPlacesOfPublication().

DefaultRecord::getPublicationFrequency() — Method in class DefaultRecord

Get an array of publication frequency information.

DefaultRecord::getPublishers() — Method in class DefaultRecord

Get the publishers of the record.

DefaultRecord::getRealTimeHistory() — Method in class DefaultRecord

Get an array of information about record history, obtained in real-time from the ILS.

DefaultRecord::getRealTimeHoldings() — Method in class DefaultRecord

Get an array of information about record holdings, obtained in real-time from the ILS.

DefaultRecord::getRelationshipNotes() — Method in class DefaultRecord

Get an array of strings describing relationships to other items.

DefaultRecord::getSecondaryAuthors() — Method in class DefaultRecord

Get an array of all secondary authors (complementing getPrimaryAuthors()).

DefaultRecord::getSecondaryAuthorsRoles() — Method in class DefaultRecord

Get an array of all secondary authors roles (complementing getPrimaryAuthorsRoles()).

DefaultRecord::getSeries() — Method in class DefaultRecord

Get an array of all series names containing the record. Array entries may be either the name string, or an associative array with 'name' and 'number' keys.

DefaultRecord::getShortTitle() — Method in class DefaultRecord

Get the short (pre-subtitle) title of the record.

DefaultRecord::getSource() — Method in class DefaultRecord

Get the item's source.

DefaultRecord::getSubtitle() — Method in class DefaultRecord

Get the subtitle of the record.

DefaultRecord::getSystemDetails() — Method in class DefaultRecord

Get an array of technical details on the item represented by the record.

DefaultRecord::getSummary() — Method in class DefaultRecord

Get an array of summary strings for the record.

DefaultRecord::getTargetAudienceNotes() — Method in class DefaultRecord

Get an array of note about the record's target audience.

DefaultRecord::getThumbnail() — Method in class DefaultRecord

Returns one of three things: a full URL to a thumbnail preview of the record if an image is available in an external system; an array of parameters to send to VuFind's internal cover generator if no fixed URL exists; or false if no thumbnail can be generated.

DefaultRecord::getTitle() — Method in class DefaultRecord

Get the full title of the record.

DefaultRecord::getTitleSection() — Method in class DefaultRecord

Get the text of the part/section portion of the title.

DefaultRecord::getTitleStatement() — Method in class DefaultRecord

Get the statement of responsibility that goes with the title (i.e. "by John Smith").

DefaultRecord::getTOC() — Method in class DefaultRecord

Get an array of lines from the table of contents.

DefaultRecord::getHierarchicalPlaceNames() — Method in class DefaultRecord

Get hierarchical place names

DefaultRecord::getUPC() — Method in class DefaultRecord

Get the UPC number(s) of the record.

DefaultRecord::getUuids() — Method in class DefaultRecord

Get UUIDs (Universally unique identifier). These are commonly used in, for example, digital library or repository systems and can be a useful match point with third party systems.

DefaultRecord::getCleanUuid() — Method in class DefaultRecord

Get just the first listed UUID (Universally unique identifier), or false if none available.

DefaultRecord::getURLs() — Method in class DefaultRecord

Return an array of associative URL arrays with one or more of the following keys:

DefaultRecord::getHierarchyTopID() — Method in class DefaultRecord

Get the hierarchy_top_id(s) associated with this item (empty if none).

DefaultRecord::getHierarchyTopTitle() — Method in class DefaultRecord

Get the absolute parent title(s) associated with this item (empty if none).

DefaultRecord::getContainingCollections() — Method in class DefaultRecord

Get an associative array (id => title) of collections containing this record.

DefaultRecord::getHierarchyTrees() — Method in class DefaultRecord

Get a list of hierarchy trees containing this record.

DefaultRecord::getHierarchyType() — Method in class DefaultRecord

Get the Hierarchy Type (false if none)

DefaultRecord::getUniqueID() — Method in class DefaultRecord

Return the unique identifier of this record within the index; useful for retrieving additional information (like tags and user comments) from the external MySQL database.

DefaultRecord::getXML() — Method in class DefaultRecord

Return an XML representation of the record using the specified format.

DefaultRecord::getSupportedCitationFormats() — Method in class DefaultRecord

Get an array of strings representing citation formats supported by this record's data (empty if none). For possible legal values, see /application/themes/root/helpers/Citation.php, getCitation() method.

DefaultRecord::getContainerTitle() — Method in class DefaultRecord

Get the title of the item that contains this record (i.e. MARC 773s of a journal).

DefaultRecord::getContainerVolume() — Method in class DefaultRecord

Get the volume of the item that contains this record (i.e. MARC 773v of a journal).

DefaultRecord::getContainerIssue() — Method in class DefaultRecord

Get the issue of the item that contains this record (i.e. MARC 773l of a journal).

DefaultRecord::getContainerStartPage() — Method in class DefaultRecord

Get the start page of the item that contains this record (i.e. MARC 773q of a journal).

DefaultRecord::getContainerEndPage() — Method in class DefaultRecord

Get the end page of the item that contains this record.

DefaultRecord::getContainerReference() — Method in class DefaultRecord

Get a full, free-form reference to the context of the item that contains this record (i.e. volume, year, issue, pages).

DefaultRecord::getSortTitle() — Method in class DefaultRecord

Get a sortable title for the record (i.e. no leading articles).

DefaultRecord::getSchemaOrgFormatsArray() — Method in class DefaultRecord

Get schema.org type mapping, an array of sub-types of http://schema.org/CreativeWork, defaulting to CreativeWork itself if nothing else matches.

DefaultRecord::getSchemaOrgFormats() — Method in class DefaultRecord

Get schema.org type mapping, expected to be a space-delimited string of sub-types of http://schema.org/CreativeWork, defaulting to CreativeWork itself if nothing else matches.

DefaultRecord::getDedupData() — Method in class DefaultRecord

Get information on records deduplicated with this one

DefaultRecord::getChildRecordCount() — Method in class DefaultRecord

Get the number of child records belonging to this record

DefaultRecord::getContainerRecordID() — Method in class DefaultRecord

Get the container record id.

DefaultRecord::getGeoLocation() — Method in class DefaultRecord

Get the bbox-geo variable.

DefaultRecord::getDisplayCoordinates() — Method in class DefaultRecord

Get the map display (lat/lon) coordinates

DefaultRecord::getCoordinateLabels() — Method in class DefaultRecord

Get the map display (lat/lon) labels

EDS::getUniqueID() — Method in class EDS

Return the unique identifier of this record within the Solr index; useful for retrieving additional information (like tags and user comments) from the external MySQL database.

EDS::getShortTitle() — Method in class EDS

Get the short (pre-subtitle) title of the record.

EDS::getSubtitle() — Method in class EDS

Get the subtitle (if any) of the record.

EDS::getItemsAbstract() — Method in class EDS

Get the abstract (summary) of the record.

EDS::getAccessLevel() — Method in class EDS

Get the access level of the record.

EDS::getItemsAuthors() — Method in class EDS

Get the authors of the record

EDS::getItemsAuthorsArray() — Method in class EDS

Obtain an array or authors indicated on the record

EDS::getCustomLinks() — Method in class EDS

Get the custom links of the record.

EDS::getFTCustomLinks() — Method in class EDS

Get the full text custom links of the record.

EDS::getDbLabel() — Method in class EDS

Get the database label of the record.

EDS::getHTMLFullText() — Method in class EDS

Get the full text of the record.

EDS::getItems() — Method in class EDS

Get the items of the record.

EDS::getPLink() — Method in class EDS

Get the full text url of the record.

EDS::getPubType() — Method in class EDS

Get the publication type of the record.

EDS::getPubTypeId() — Method in class EDS

Get the publication type id of the record.

EDS::getEbookLink() — Method in class EDS

Get the ebook url of the record. If missing, return false

EDS::getPdfLink() — Method in class EDS

Get the PDF url of the record. If missing, return false

EDS::getEpubLink() — Method in class EDS

Get the ePub url of the record. If missing, return false

EDS::getLinkedFullTextLink() — Method in class EDS

Get the linked full text url of the record. If missing, return false

EDS::getItemsSubjects() — Method in class EDS

Get the subject data of the record.

EDS::getThumbnail() — Method in class EDS

Return a URL to a thumbnail preview of the record, if available; false otherwise.

EDS::getItemsTitle() — Method in class EDS

Get the title of the record.

EDS::getTitle() — Method in class EDS

Obtain the title of the record from the record info section

EDS::getPrimaryAuthors() — Method in class EDS

Obtain the authors from a record from the RecordInfo section

EDS::getItemsTitleSource() — Method in class EDS

Get the source of the record.

EDS::getCleanDOI() — Method in class EDS

Return the first valid DOI found in the record (false if none).

EDS::getLanguages() — Method in class EDS

Get record languages

EDS::getFilteredIdentifiers() — Method in class EDS

Retrieve identifiers from the EBSCO record and retrieve values filtered by type.

EDS::getISSNs() — Method in class EDS

Get ISSNs (of containing record)

EDS::getISBNs() — Method in class EDS

Get an array of ISBNs

EDS::getContainerTitle() — Method in class EDS

Get title of containing record

EDS::getFilteredNumbering() — Method in class EDS

Extract numbering data of a particular type.

EDS::getContainerIssue() — Method in class EDS

Get issue of containing record

EDS::getContainerVolume() — Method in class EDS

Get volume of containing record

EDS::getPublicationDates() — Method in class EDS

Get the publication dates of the record. See also getDateSpan().

EDS::getContainerStartPage() — Method in class EDS

Get year of containing record

EDS::getContainerEndPage() — Method in class EDS

Get the end page of the item that contains this record.

EDS::getFormats() — Method in class EDS

Returns an array of formats based on publication type.

EDS::getPublishers() — Method in class EDS

Get the publishers of the record.

EDS::getPlacesOfPublication() — Method in class EDS

Get the item's place of publication.

EDS::getPublicationDetails() — Method in class EDS

Get an array of publication detail lines combining information from getPublicationDates(), getPublishers() and getPlacesOfPublication().

EDS::getRawEDSPublicationDetails() — Method in class EDS

Attempt to build up publication details from raw EDS data.

EIT::getAllSubjectHeadings() — Method in class EIT

Get all subject headings associated with this record. Each heading is returned as an array of chunks, increasing from least specific to most specific.

EIT::getBreadcrumb() — Method in class EIT

Get text that can be displayed to represent this record in breadcrumbs.

EIT::getCallNumbers() — Method in class EIT

Get the call numbers associated with the record (empty string if none).

EIT::getCleanOCLCNum() — Method in class EIT

Get just the first listed OCLC Number (or false if none available).

EIT::getCleanISSN() — Method in class EIT

Get just the first ISSN (or false if none available).

EIT::getDateSpan() — Method in class EIT

Get the date coverage for a record which spans a period of time (i.e. a journal). Use getPublicationDates for publication dates of particular monographic items.

EIT::getEdition() — Method in class EIT

Get the edition of the current record.

EIT::getFormats() — Method in class EIT

Get an array of all the formats associated with the record.

EIT::getPrimaryAuthors() — Method in class EIT

Get the main author of the record.

EIT::getPublicationDates() — Method in class EIT

Get the publication dates of the record. See also getDateSpan().

EIT::getPublishers() — Method in class EIT

Get the publishers of the record.

EIT::getShortTitle() — Method in class EIT

Get the short (pre-subtitle) title of the record.

EIT::getSummary() — Method in class EIT

Get an array of summary strings for the record.

EIT::getTitle() — Method in class EIT

Get the full title of the record.

EIT::getURLs() — Method in class EIT

Return an array of associative URL arrays with one or more of the following keys:

EIT::getUniqueID() — Method in class EIT

Return the unique identifier of this record within the Solr index; useful for retrieving additional information (like tags and user comments) from the external MySQL database.

EIT::getContainerTitle() — Method in class EIT

Get the title of the item that contains this record (i.e. MARC 773s of a journal).

EIT::getContainerVolume() — Method in class EIT

Get the volume of the item that contains this record (i.e. MARC 773v of a journal).

EIT::getContainerIssue() — Method in class EIT

Get the issue of the item that contains this record (i.e. MARC 773l of a journal).

EIT::getContainerStartPage() — Method in class EIT

Get the start page of the item that contains this record (i.e. MARC 773q of a journal).

EIT::getContainerPageCount() — Method in class EIT

Support method for getContainerEndPage()

EIT::getContainerEndPage() — Method in class EIT

Get the end page of the item that contains this record.

EIT::getSortTitle() — Method in class EIT

Get a sortable title for the record (i.e. no leading articles).

EIT::getOpenUrlFormat() — Method in class EIT

Support method for getOpenUrl() -- pick the OpenURL format.

EIT::getCoinsID() — Method in class EIT

Get the COinS identifier.

EIT::getContainerReference() — Method in class EIT

Get a full, free-form reference to the context of the item that contains this record (i.e. volume, year, issue, pages).

HierarchyAwareTrait::getHierarchyDriver() — Method in class HierarchyAwareTrait

Get a hierarchy driver appropriate to the current object. (May be false if disabled/unavailable).

HierarchyAwareTrait::getHierarchyTopID() — Method in class HierarchyAwareTrait

Get the hierarchy_top_id(s) associated with this item (empty if none).

HierarchyAwareTrait::getHierarchyTopTitle() — Method in class HierarchyAwareTrait

Get the absolute parent title(s) associated with this item (empty if none).

HierarchyAwareTrait::getContainingCollections() — Method in class HierarchyAwareTrait

Get an associative array (id => title) of collections containing this record.

HierarchyAwareTrait::getHierarchyTrees() — Method in class HierarchyAwareTrait

Get a list of hierarchy trees containing this record.

HierarchyAwareTrait::getHierarchyType() — Method in class HierarchyAwareTrait

Get the Hierarchy Type (false if none)

IlsAwareTrait::getRealTimeHoldings() — Method in class IlsAwareTrait

Get an array of information about record holdings, obtained in real-time from the ILS.

IlsAwareTrait::getRealTimeHistory() — Method in class IlsAwareTrait

Get an array of information about record history, obtained in real-time from the ILS.

IlsAwareTrait::getRealTimeTitleHold() — Method in class IlsAwareTrait

Get a link for placing a title level hold.

MarcAdvancedTrait::getAccessRestrictions() — Method in class MarcAdvancedTrait

Get access restriction notes for the record.

MarcAdvancedTrait::getAllSubjectHeadings() — Method in class MarcAdvancedTrait

Get all subject headings associated with this record. Each heading is returned as an array of chunks, increasing from least specific to most specific.

MarcAdvancedTrait::getAwards() — Method in class MarcAdvancedTrait

Get award notes for the record.

MarcAdvancedTrait::getBibliographicLevel() — Method in class MarcAdvancedTrait

Get the bibliographic level of the current record.

MarcAdvancedTrait::getBibliographyNotes() — Method in class MarcAdvancedTrait

Get notes on bibliography content.

MarcAdvancedTrait::getFilteredXML() — Method in class MarcAdvancedTrait

Return full record as filtered XML for public APIs.

MarcAdvancedTrait::getFindingAids() — Method in class MarcAdvancedTrait

Get notes on finding aids related to the record.

MarcAdvancedTrait::getGeneralNotes() — Method in class MarcAdvancedTrait

Get general notes on the record.

MarcAdvancedTrait::getHumanReadablePublicationDates() — Method in class MarcAdvancedTrait

Get human readable publication dates for display purposes (may not be suitable for computer processing -- use getPublicationDates() for that).

MarcAdvancedTrait::getNewerTitles() — Method in class MarcAdvancedTrait

Get an array of newer titles for the record.

MarcAdvancedTrait::getPlacesOfPublication() — Method in class MarcAdvancedTrait

Get the item's places of publication.

MarcAdvancedTrait::getPlayingTimes() — Method in class MarcAdvancedTrait

Get an array of playing times for the record (if applicable).

MarcAdvancedTrait::getPreviousTitles() — Method in class MarcAdvancedTrait

Get an array of previous titles for the record.

MarcAdvancedTrait::getProductionCredits() — Method in class MarcAdvancedTrait

Get credits of people involved in production of the item.

MarcAdvancedTrait::getPublicationFrequency() — Method in class MarcAdvancedTrait

Get an array of publication frequency information.

MarcAdvancedTrait::getRelationshipNotes() — Method in class MarcAdvancedTrait

Get an array of strings describing relationships to other items.

MarcAdvancedTrait::getSeries() — Method in class MarcAdvancedTrait

Get an array of all series names containing the record. Array entries may be either the name string, or an associative array with 'name' and 'number' keys.

MarcAdvancedTrait::getSeriesFromMARC() — Method in class MarcAdvancedTrait

Support method for getSeries() -- given a field specification, look for series information in the MARC record.

MarcAdvancedTrait::getSummary() — Method in class MarcAdvancedTrait

Get an array of summary strings for the record.

MarcAdvancedTrait::getSystemDetails() — Method in class MarcAdvancedTrait

Get an array of technical details on the item represented by the record.

MarcAdvancedTrait::getTargetAudienceNotes() — Method in class MarcAdvancedTrait

Get an array of note about the record's target audience.

MarcAdvancedTrait::getTitleSection() — Method in class MarcAdvancedTrait

Get the text of the part/section portion of the title.

MarcAdvancedTrait::getTitleStatement() — Method in class MarcAdvancedTrait

Get the statement of responsibility that goes with the title (i.e. "by John Smith").

MarcAdvancedTrait::getTOC() — Method in class MarcAdvancedTrait

Get an array of lines from the table of contents.

MarcAdvancedTrait::getHierarchicalPlaceNames() — Method in class MarcAdvancedTrait

Get hierarchical place names (MARC field 752)

MarcAdvancedTrait::getURLs() — Method in class MarcAdvancedTrait

Return an array of associative URL arrays with one or more of the following keys:

MarcAdvancedTrait::getAllRecordLinks() — Method in class MarcAdvancedTrait

Get all record links related to the current record. Each link is returned as array.

MarcAdvancedTrait::getRecordLinkNote() — Method in class MarcAdvancedTrait

Support method for getFieldData() -- factor the relationship indicator into the field number where relevant to generate a note to associate with a record link.

MarcAdvancedTrait::getFieldData() — Method in class MarcAdvancedTrait

Returns the array element for the 'getAllRecordLinks' method

MarcAdvancedTrait::getIdFromLinkingField() — Method in class MarcAdvancedTrait

Returns an id extracted from the identifier subfield passed in

MarcAdvancedTrait::getFormattedMarcDetails() — Method in class MarcAdvancedTrait

Get Status/Holdings Information from the internally stored MARC Record (support method used by the NoILS driver).

MarcAdvancedTrait::getXML() — Method in class MarcAdvancedTrait

Return an XML representation of the record using the specified format.

MarcAdvancedTrait::getRDFXML() — Method in class MarcAdvancedTrait

Get an XML RDF representation of the data in this record.

MarcAdvancedTrait::getConsortialIDs() — Method in class MarcAdvancedTrait

Return the list of "source records" for this consortial record.

MarcAdvancedTrait::getCleanISMN() — Method in class MarcAdvancedTrait

Return first ISMN found for this record, or false if no one fonund

MarcAdvancedTrait::getCleanNBN() — Method in class MarcAdvancedTrait

Return first national bibliography number found, or false if not found

MarcAdvancedTrait::getTitlesAltScript() — Method in class MarcAdvancedTrait

Get the full titles of the record in alternative scripts.

MarcAdvancedTrait::getFullTitlesAltScript() — Method in class MarcAdvancedTrait

Get the full titles of the record including section and part information in alternative scripts.

MarcAdvancedTrait::getShortTitlesAltScript() — Method in class MarcAdvancedTrait

Get the short (pre-subtitle) title of the record in alternative scripts.

MarcAdvancedTrait::getSubtitlesAltScript() — Method in class MarcAdvancedTrait

Get the subtitle of the record in alternative script.

MarcAdvancedTrait::getTitleSectionsAltScript() — Method in class MarcAdvancedTrait

Get the text of the part/section portion of the title in alternative scripts.

MarcBasicTrait::getISBNs() — Method in class MarcBasicTrait

Get an array of all ISBNs associated with the record (may be empty).

MarcBasicTrait::getISSNs() — Method in class MarcBasicTrait

Get an array of all ISSNs associated with the record (may be empty).

MarcBasicTrait::getFormats() — Method in class MarcBasicTrait

Get an array of all the formats associated with the record.

MarcBasicTrait::getUniqueID() — Method in class MarcBasicTrait

Return the unique identifier of this record within the Solr index; useful for retrieving additional information (like tags and user comments) from the external MySQL database.

MarcBasicTrait::getCallNumbers() — Method in class MarcBasicTrait

Get the call numbers associated with the record (empty string if none).

MarcBasicTrait::getDeweyCallNumber() — Method in class MarcBasicTrait

Get the Dewey call number associated with this record (empty string if none).

MarcBasicTrait::getPrimaryAuthors() — Method in class MarcBasicTrait

Get the main authors of the record.

MarcBasicTrait::getLanguages() — Method in class MarcBasicTrait

Get an array of all the languages associated with the record.

MarcBasicTrait::getTitle() — Method in class MarcBasicTrait

Get the full title of the record.

MarcBasicTrait::getSortTitle() — Method in class MarcBasicTrait

Get a sortable title for the record (i.e. no leading articles).

MarcBasicTrait::getShortTitle() — Method in class MarcBasicTrait

Get the short (pre-subtitle) title of the record.

MarcBasicTrait::getSubtitle() — Method in class MarcBasicTrait

Get the subtitle of the record.

MarcBasicTrait::getPublishers() — Method in class MarcBasicTrait

Get the publishers of the record.

MarcBasicTrait::getDateSpan() — Method in class MarcBasicTrait

Get the date coverage for a record which spans a period of time (i.e. a journal). Use getPublicationDates for publication dates of particular monographic items.

MarcBasicTrait::getPublicationDates() — Method in class MarcBasicTrait

Get the publication dates of the record. See also getDateSpan().

MarcBasicTrait::getCorporateAuthors() — Method in class MarcBasicTrait

Get an array of all corporate authors (complementing getPrimaryAuthor()).

MarcBasicTrait::getSecondaryAuthors() — Method in class MarcBasicTrait

Get an array of all secondary authors (complementing getPrimaryAuthors()).

MarcBasicTrait::getNewerTitles() — Method in class MarcBasicTrait

Get an array of newer titles for the record.

MarcBasicTrait::getPreviousTitles() — Method in class MarcBasicTrait

Get an array of previous titles for the record.

MarcBasicTrait::getEdition() — Method in class MarcBasicTrait

Get the edition of the current record.

MarcBasicTrait::getRawLCCN() — Method in class MarcBasicTrait

Get a raw, unnormalized LCCN. (See DefaultRecord::getLCCN for normalization).

MarcBasicTrait::getPhysicalDescriptions() — Method in class MarcBasicTrait

Get an array of physical descriptions of the item.

MarcReaderTrait::getRawMarcData() — Method in class MarcReaderTrait

Retrieve the raw MARC data for this record; note that format may vary depending on what was indexed (e.g. XML vs. binary MARC).

MarcReaderTrait::getMarcReader() — Method in class MarcReaderTrait

Get access to the MarcReader object.

MarcReaderTrait::getFieldArray() — Method in class MarcReaderTrait

Return an array of all values extracted from the specified field/subfield combination. If multiple subfields are specified and $concat is true, they will be concatenated together in the order listed -- each entry in the array will correspond with a single MARC field. If $concat is false, the return array will contain separate entries for separate subfields.

MarcReaderTrait::getFirstFieldValue() — Method in class MarcReaderTrait

Get the first value matching the specified MARC field and subfields.

MarcReaderTrait::getPublicationInfo() — Method in class MarcReaderTrait

Get the item's publication information

MarcReaderTrait::getSubfield() — Method in class MarcReaderTrait

Return first subfield with the given code in the provided MARC field

MarcReaderTrait::getSubfields() — Method in class MarcReaderTrait

Return all subfields with the given code in the provided MARC field

MarcReaderTrait::getSubfieldArray() — Method in class MarcReaderTrait

Return an array of non-empty subfield values found in the provided MARC field. If $concat is true, the array will contain either zero or one entries (empty array if no subfields found, subfield values concatenated together in specified order if found). If concat is false, the array will contain a separate entry for each subfield value found.

PreviousUniqueIdInterface::getPreviousUniqueId() — Method in class PreviousUniqueIdInterface

Get previous unique ID (or null if not applicable).

PreviousUniqueIdTrait::getPreviousUniqueId() — Method in class PreviousUniqueIdTrait

Get previous unique ID (or null if not applicable).

VersionAwareInterface::getWorkKeys() — Method in class VersionAwareInterface

Get work identification keys

VersionAwareTrait::getOtherVersionCount() — Method in class VersionAwareTrait

Return count of other versions available

VersionAwareTrait::getVersions() — Method in class VersionAwareTrait

Retrieve versions as a search result

IlsAwareDelegatorFactory::getIlsBackends() — Method in class IlsAwareDelegatorFactory

Get the ILS backend configuration.

LibGuides::getShortTitle() — Method in class LibGuides

Get the short (pre-subtitle) title of the record.

Missing::getShortTitle() — Method in class Missing

Get the short title of the record.

Missing::getTitle() — Method in class Missing

Get the full title of the record.

Missing::getFormats() — Method in class Missing

Get an array of all the formats associated with the record.

Pazpar2::getUniqueId() — Method in class Pazpar2

Return the unique identifier of this record within the Solr index; useful for retrieving additional information (like tags and user comments) from the external MySQL database.

Pazpar2::getPrimaryAuthors() — Method in class Pazpar2

Get the main authors of the record.

Pazpar2::getProviders() — Method in class Pazpar2

Get the providers of the record.

Pazpar2::getPublicationDates() — Method in class Pazpar2

Get the publication dates of the record. See also getDateSpan().

Pazpar2::getTitle() — Method in class Pazpar2

Get the full title of the record.

Pazpar2::getShortTitle() — Method in class Pazpar2

Get the short (pre-subtitle) title of the record.

Pazpar2::getURLs() — Method in class Pazpar2

Return an array of associative URL arrays with one or more of the following keys:

Pazpar2::getOpenUrlFormat() — Method in class Pazpar2

Support method for getOpenUrl() -- pick the OpenURL format.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

PluginManager::getSolrRecord() — Method in class PluginManager

Convenience method to retrieve a populated Solr record driver.

PluginManager::getSearch2Record() — Method in class PluginManager

Convenience method to retrieve a populated Search2 record driver.

PluginManager::getSolrAuthRecord() — Method in class PluginManager

Convenience method to retrieve a populated Solr authority record driver.

Primo::getShortTitle() — Method in class Primo

Get the short (pre-subtitle) title of the record.

Primo::getTitle() — Method in class Primo

Get the full title of the record.

Primo::getHighlightedTitle() — Method in class Primo

Get a highlighted title string, if available.

Primo::getPrimaryAuthors() — Method in class Primo

Get the main authors of the record.

Primo::getCreators() — Method in class Primo

Get the authors of the record.

Primo::getAllSubjectHeadings() — Method in class Primo

Get an array of all subject headings associated with the record (may be empty).

Primo::getContainerReference() — Method in class Primo

Get a full, free-form reference to the context of the item that contains this record (i.e. volume, year, issue, pages).

Primo::getContainerEndPage() — Method in class Primo

Get the end page of the item that contains this record.

Primo::getFormats() — Method in class Primo

Get an array of all the formats associated with the record.

Primo::getIsPartOf() — Method in class Primo

Get the item's "is part of".

Primo::getDescription() — Method in class Primo

Get the item's description.

Primo::getSource() — Method in class Primo

Get the item's source.

Primo::getISSNs() — Method in class Primo

Get an array of all ISSNs associated with the record (may be empty).

Primo::getLanguages() — Method in class Primo

Get the language associated with the record.

Primo::getThumbnail() — Method in class Primo

Returns one of three things: a full URL to a thumbnail preview of the record if an image is available in an external system; an array of parameters to send to VuFind's internal cover generator if no fixed URL exists; or false if no thumbnail can be generated.

Primo::getURLs() — Method in class Primo

Return an array of associative URL arrays with one or more of the following keys:

Primo::getUniqueID() — Method in class Primo

Return the unique identifier of this record within the Solr index; useful for retrieving additional information (like tags and user comments) from the external MySQL database.

Primo::getSupportedCitationFormats() — Method in class Primo

Get an array of strings representing citation formats supported by this record's data (empty if none). For possible legal values, see /application/themes/root/helpers/Citation.php, getCitation() method.

PublicationDetails::getPlace() — Method in class PublicationDetails

Get place of publication

PublicationDetails::getName() — Method in class PublicationDetails

Get name of publisher

PublicationDetails::getDate() — Method in class PublicationDetails

Get date of publication

Search2Default::getHierarchyType() — Method in class Search2Default

Get the Hierarchy Type (false if none)

SolrArchivesSpace::getURLs() — Method in class SolrArchivesSpace

Return an array of associative URL arrays with one or more of the following keys:

SolrAuthDefault::getShortTitle() — Method in class SolrAuthDefault

Get the short (pre-subtitle) title of the record.

SolrAuthDefault::getTitle() — Method in class SolrAuthDefault

Get the full title of the record.

SolrAuthDefault::getSeeAlso() — Method in class SolrAuthDefault

Get the see also references for the record.

SolrAuthDefault::getUseFor() — Method in class SolrAuthDefault

Get the use for references for the record.

SolrAuthMarc::getRawLCCN() — Method in class SolrAuthMarc

Get a raw LCCN (not normalized). Returns false if none available.

SolrDefault::getFirstIndexed() — Method in class SolrDefault

Get the date this record was first indexed (if set).

SolrDefault::getHighlightDetails() — Method in class SolrDefault

Get highlighting details from the object.

SolrDefault::getRawAuthorHighlights() — Method in class SolrDefault

Get highlighted author data, if available.

SolrDefault::getSnippetCaption() — Method in class SolrDefault

Given a Solr field name, return an appropriate caption.

SolrDefault::getHighlightedSnippet() — Method in class SolrDefault

Pick one line from the highlighted text (if any) to use as a snippet.

SolrDefault::getHighlightedTitle() — Method in class SolrDefault

Get a highlighted title string, if available.

SolrDefault::getChildRecordCount() — Method in class SolrDefault

Get the number of child records belonging to this record

SolrDefault::getContainerRecordID() — Method in class SolrDefault

Get the container record id.

SolrDefault::getWorkKeys() — Method in class SolrDefault

Get work identification keys

SolrMarcRemote::getMarcReader() — Method in class SolrMarcRemote

Get access to the MarcReader object.

SolrMarcRemote::getRemoteFullrecord() — Method in class SolrMarcRemote

Retrieves the full Marcrecord from a remote service defined by uriPattern

SolrOverdrive::getAvailableDigitalFormats() — Method in class SolrOverdrive

Get Available Digital Formats

SolrOverdrive::getDigitalFormats() — Method in class SolrOverdrive

Get Formats

SolrOverdrive::getFormattedDigitalFormats() — Method in class SolrOverdrive

Get an array of all the formats associated with the record with metadata associated with it. This array is designed to be used in a template.

SolrOverdrive::getPreviewLinks() — Method in class SolrOverdrive

Returns links for showing previews

SolrOverdrive::getOverdriveAccess() — Method in class SolrOverdrive

Get Overdrive Access

SolrOverdrive::getOverdriveID() — Method in class SolrOverdrive

Get Overdrive ID

SolrOverdrive::getOverdriveAvailability() — Method in class SolrOverdrive

Returns the availability for the current record

SolrOverdrive::getBreadcrumb() — Method in class SolrOverdrive

Get Bread Crumb

SolrOverdrive::getMarcReader() — Method in class SolrOverdrive

Get Marc Reader

SolrOverdrive::getTitleSection() — Method in class SolrOverdrive

Get Title Section

SolrOverdrive::getGeneralNotes() — Method in class SolrOverdrive

Get general notes on the record.

SolrOverdrive::getThumbnail() — Method in class SolrOverdrive

Returns one of three things: a full URL to a thumbnail preview of the record if an image is available in an external system; an array of parameters to send to VuFind's internal cover generator if no fixed URL exists; or false if no thumbnail can be generated.

SolrOverdrive::getSummary() — Method in class SolrOverdrive

Get an array of summary strings for the record.

SolrOverdrive::getRawData() — Method in class SolrOverdrive

Retrieve raw data from object (primarily for use in staff view and autocomplete; avoid using whenever possible).

SolrOverdrive::getIsMarc() — Method in class SolrOverdrive

Is Marc Based Record

SolrOverdrive::getAllSubjectHeadings() — Method in class SolrOverdrive

Get all subject headings associated with this record. Each heading is returned as an array of chunks, increasing from least specific to most specific.

SolrOverdrive::getFormattedRawData() — Method in class SolrOverdrive

Get Formatted Raw Data

SolrOverdrive::getRealTimeTitleHold() — Method in class SolrOverdrive

Get a link for placing a title level hold.

SolrReserves::getInstructor() — Method in class SolrReserves

Get the instructor.

SolrReserves::getInstructorId() — Method in class SolrReserves

Get the instructor ID.

SolrReserves::getCourse() — Method in class SolrReserves

Get the course.

SolrReserves::getCourseId() — Method in class SolrReserves

Get the course ID.

SolrReserves::getDepartment() — Method in class SolrReserves

Get the department.

SolrReserves::getDepartmentId() — Method in class SolrReserves

Get the department ID.

SolrReserves::getItemCount() — Method in class SolrReserves

Get a count of items associated with this record.

SolrReserves::getItemIds() — Method in class SolrReserves

Get the list of attached reserves.

SolrWeb::getBreadcrumb() — Method in class SolrWeb

Get text that can be displayed to represent this record in breadcrumbs.

SolrWeb::getUrl() — Method in class SolrWeb

Get the URL for the current record.

SolrWeb::getLastModified() — Method in class SolrWeb

Get the last modified date for the current record (or empty string if unset).

Summon::getAllSubjectHeadings() — Method in class Summon

Get all subject headings associated with this record. Each heading is returned as an array of chunks, increasing from least specific to most specific.

Summon::getBibliographyNotes() — Method in class Summon

Get notes on bibliography content.

Summon::getCallNumbers() — Method in class Summon

Get the call numbers associated with the record (empty string if none).

Summon::getCleanDOI() — Method in class Summon

Return the first valid DOI found in the record (false if none).

Summon::getEdition() — Method in class Summon

Get the edition of the current record.

Summon::getExtraResourceMetadata() — Method in class Summon

Get extra metadata to store in the resource table. In this instance, we use the BookMark value so that it can be used to recover expired records in favorite lists.

Summon::getFormats() — Method in class Summon

Get an array of all the formats associated with the record.

Summon::getRawAuthorHighlights() — Method in class Summon

Get highlighted author data, if available.

Summon::getHighlightedSnippet() — Method in class Summon

Pick one line from the highlighted text (if any) to use as a snippet.

Summon::getHighlightedTitle() — Method in class Summon

Get a highlighted title string, if available.

Summon::getISBNs() — Method in class Summon

Get an array of all ISBNs associated with the record (may be empty).

Summon::getISSNs() — Method in class Summon

Get an array of all ISSNs associated with the record (may be empty).

Summon::getLanguages() — Method in class Summon

Get an array of all the languages associated with the record.

Summon::getOCLC() — Method in class Summon

Get the OCLC number of the record.

Summon::getOpenUrl() — Method in class Summon

Get the OpenURL parameters to represent this record (useful for the title attribute of a COinS span tag).

Summon::getPlacesOfPublication() — Method in class Summon

Get the item's place of publication.

Summon::getDateConverter() — Method in class Summon

Get a date converter

Summon::getPublicationDates() — Method in class Summon

Get the publication dates of the record. See also getDateSpan().

Summon::getPublishers() — Method in class Summon

Get the publishers of the record.

Summon::getPrimaryAuthors() — Method in class Summon

Get an array of all primary authors.

Summon::getSeries() — Method in class Summon

Get an array of all series names containing the record. Array entries may be either the name string, or an associative array with 'name' and 'number' keys.

Summon::getShortTitle() — Method in class Summon

Get the short (pre-subtitle) title of the record.

Summon::getSubtitle() — Method in class Summon

Get the subtitle of the record.

Summon::getSummary() — Method in class Summon

Get an array of summary strings for the record.

Summon::getThumbnail() — Method in class Summon

Returns one of three things: a full URL to a thumbnail preview of the record if an image is available in an external system; an array of parameters to send to VuFind's internal cover generator if no fixed URL exists; or false if no thumbnail can be generated.

Summon::getTitle() — Method in class Summon

Get the full title of the record.

Summon::getTOC() — Method in class Summon

Get an array of lines from the table of contents.

Summon::getURLs() — Method in class Summon

Return an array of associative URL arrays with one or more of the following keys:

Summon::getUniqueID() — Method in class Summon

Return the unique identifier of this record within the Solr index; useful for retrieving additional information (like tags and user comments) from the external MySQL database.

Summon::getContainerTitle() — Method in class Summon

Get the title of the item that contains this record (i.e. MARC 773s of a journal).

Summon::getContainerVolume() — Method in class Summon

Get the volume of the item that contains this record (i.e. MARC 773v of a journal).

Summon::getContainerIssue() — Method in class Summon

Get the issue of the item that contains this record (i.e. MARC 773l of a journal).

Summon::getContainerStartPage() — Method in class Summon

Get the start page of the item that contains this record (i.e. MARC 773q of a journal).

Summon::getContainerEndPage() — Method in class Summon

Get the end page of the item that contains this record.

Summon::getContainerReference() — Method in class Summon

Get a full, free-form reference to the context of the item that contains this record (i.e. volume, year, issue, pages).

WorldCat::getOCLC() — Method in class WorldCat

Get the OCLC number of the record.

AbstractBase::getRecordDriver() — Method in class AbstractBase

Get the record driver

AbstractBase::getRequest() — Method in class AbstractBase

Get the user request (or false if unavailable)

AbstractContent::getContent() — Method in class AbstractContent

Get content for ISBN.

AbstractContentFactory::getHideSetting() — Method in class AbstractContentFactory

Support method for construction of AbstractContent objects -- should we hide this tab if it is empty?

CollectionHierarchyTree::getActiveRecord() — Method in class CollectionHierarchyTree

Get the current active record. Returns record driver if found, false if no record requested, null if ID invalid.

CollectionList::getDescription() — Method in class CollectionList

Get the on-screen description for this tab.

CollectionList::getParams() — Method in class CollectionList

Get the current search parameters.

CollectionList::getResults() — Method in class CollectionList

Get the processed search results.

ComponentParts::getDescription() — Method in class ComponentParts

Get the on-screen description for this tab.

ComponentParts::getMaxResults() — Method in class ComponentParts

Get the maximum result count.

ComponentParts::getResults() — Method in class ComponentParts

Get the contents for display.

Description::getDescription() — Method in class Description

Get the on-screen description for this tab.

Excerpt::getDescription() — Method in class Excerpt

Get the on-screen description for this tab.

Formats::getDescription() — Method in class Formats

Get the on-screen description for this tab.

HierarchyTree::getConfig() — Method in class HierarchyTree

Get the VuFind configuration.

HierarchyTree::getDescription() — Method in class HierarchyTree

Get the on-screen description for this tab.

HierarchyTree::getActiveTree() — Method in class HierarchyTree

Get the ID of the active tree (false if none)

HierarchyTree::getTreeList() — Method in class HierarchyTree

Get an array of tree data

HierarchyTree::getSearchLimit() — Method in class HierarchyTree

Get the tree search result limit.

HoldingsILS::getDescription() — Method in class HoldingsILS

Get the on-screen description for this tab.

HoldingsILS::getSimpleUniqueCallNumbers() — Method in class HoldingsILS

Support method used in getUniqueCallNumbers for templates when full details are not supported -- extract all unique call numbers from an array of items.

HoldingsILS::getUniqueCallNumbers() — Method in class HoldingsILS

Support method used by template -- extract all unique call numbers from an array of items.

HoldingsILS::getTemplate() — Method in class HoldingsILS

Get name of template for rendering holdings.

HoldingsILS::getPaginator() — Method in class HoldingsILS

Getting a paginator for the items list.

HoldingsWorldCat::getDescription() — Method in class HoldingsWorldCat

Get the on-screen description for this tab.

HoldingsWorldCat::getHoldings() — Method in class HoldingsWorldCat

Get holdings information from WorldCat (false if none available).

HoldingsWorldCat::getOCLCNum() — Method in class HoldingsWorldCat

Get the OCLC number from the active record driver.

$ Map#graticuleProperty in class Map

Display graticule / map lat long grid?

Map::getDescription() — Method in class Map

Get the on-screen description for this tab.

Map::getMapGraticule() — Method in class Map

Get the map graticule setting.

Map::getBasemap() — Method in class Map

Get the basemap configuration settings.

Map::getGeoLocationCoords() — Method in class Map

Get the bbox-geo coordinates.

Map::getDisplayCoords() — Method in class Map

Get the map display coordinates.

Map::getMapLabels() — Method in class Map

Get the map labels.

Map::getMapTabData() — Method in class Map

Construct the map coordinates and labels array.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

Preview::getDescription() — Method in class Preview

Get the on-screen description for this tab.

Reviews::getDescription() — Method in class Reviews

Get the on-screen description for this tab.

SimilarItemsCarousel::getDescription() — Method in class SimilarItemsCarousel

Get the on-screen description for this tab.

SimilarItemsCarousel::getResults() — Method in class SimilarItemsCarousel

Get an array of Record Driver objects representing items similar to the one passed to the constructor.

StaffViewArray::getDescription() — Method in class StaffViewArray

Get the on-screen description for this tab.

StaffViewMARC::getDescription() — Method in class StaffViewMARC

Get the on-screen description for this tab.

StaffViewOverdrive::getDescription() — Method in class StaffViewOverdrive

Get the on-screen description for this tab.

TOC::getDescription() — Method in class TOC

Get the on-screen description for this tab.

TabInterface::getDescription() — Method in class TabInterface

Get the on-screen description for this tab.

TabManager::getConfigByClass() — Method in class TabManager

Load the specified key from the configuration array using the best available match to the class of the provided driver. Return the default value if no match is found.

TabManager::getTabServiceNames() — Method in class TabManager

Get an array of service names by looking up the provided record driver in the provided tab configuration array.

TabManager::getBackgroundTabNames() — Method in class TabManager

Get an array of tabs names configured to load via AJAX in the background

TabManager::getExtraScripts() — Method in class TabManager

Get an array of extra JS scripts by looking up the provided record driver in the provided tab configuration array.

TabManager::getDefaultTabForRecord() — Method in class TabManager

Get a default tab by looking up the provided record driver in the tab configuration array.

TabManager::getTabDetailsForRecord() — Method in class TabManager

Convenience method to load tab information, including default, in a single pass. Returns an associative array with 'tabs' and 'default' keys.

TabManager::getTabsForRecord() — Method in class TabManager

Get an array of valid tabs for the provided record driver.

UserComments::getDescription() — Method in class UserComments

Get the on-screen description for this tab.

Versions::getDescription() — Method in class Versions

Get the on-screen description for this tab.

Cache::getVuFindRecord() — Method in class Cache

Helper function to get records from cached source-specific record data

RecordCacheAwareInterface::getRecordCache() — Method in class RecordCacheAwareInterface

Get record cache

RecordCacheAwareTrait::getRecordCache() — Method in class RecordCacheAwareTrait

Get record cache

Checklist::getChecked() — Method in class Checklist

Get list of checked values.

Checklist::getUnchecked() — Method in class Checklist

Get list of unchecked values.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

Router::getActionRouteDetails() — Method in class Router

Get routing details for a controller action.

Router::getTabRouteDetails() — Method in class Router

Get routing details to display a particular tab.

Router::getRouteDetails() — Method in class Router

Get routing details (route name and parameters array) to link to a record.

SourceAndIdList::getAll() — Method in class SourceAndIdList

Get the full list of IDs sent to the constructor, normalized to array format.

SourceAndIdList::getIdsBySource() — Method in class SourceAndIdList

Get an associative source => id list array.

SourceAndIdList::getRecordPositions() — Method in class SourceAndIdList

If the provided record driver corresponds with an ID in the list, return the associated positions in the list. Otherwise, return an empty array.

Bookplate::getBookplateData() — Method in class Bookplate

Get an array of data representing bookplates.

Bookplate::getBookplateFullUrlTemplate() — Method in class Bookplate

Get the full bookplate URL string template.

Bookplate::getBookplateThumbUrlTemplate() — Method in class Bookplate

Get the bookplate URL thumbnail string template.

Bookplate::getBookplateTitlesField() — Method in class Bookplate

Get a data field with an array of bookplate image titles.

Bookplate::getBookplateFullImagesField() — Method in class Bookplate

Get a data field with an array of strings that represent full images.

Bookplate::getBookplateThumbnailsField() — Method in class Bookplate

Get a data field with an array of strings that represent thumbnails.

Bookplate::getBookplateDetails() — Method in class Bookplate

Get bookplate details for display.

Channels::getDriver() — Method in class Channels

Get the current record driver.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

Similar::getResults() — Method in class Similar

Get an array of Record Driver objects representing items similar to the one passed to the constructor.

CsvReader::getValueFromLine() — Method in class CsvReader

Load the appropriate data field from the line using our template.

CsvReader::getInstructors() — Method in class CsvReader

Get instructor data

CsvReader::getCourses() — Method in class CsvReader

Get course data

CsvReader::getDepartments() — Method in class CsvReader

Get department data

CsvReader::getReserves() — Method in class CsvReader

Get reserves data

CsvReader::getErrors() — Method in class CsvReader

Get collected error messages

AbstractBase::getResolverUrl() — Method in class AbstractBase

Get Resolver Url

Alma::getKeyWithId() — Method in class Alma

Get a key with the specified id from the context_service element

DriverInterface::getResolverUrl() — Method in class DriverInterface

Get Resolver Url

GenericClass in namespace VuFind\Resolver\Driver

Generic Link Resolver Driver

Jop::getResolverUrl() — Method in class Jop

Get Resolver Url

Jop::getElectronicResults() — Method in class Jop

Extract electronic results from the JOP response and inject them into the $records array.

Jop::getPrintResults() — Method in class Jop

Extract print results from the JOP response and inject them into the $records array.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

DynamicRoleProvider::getRoles() — Method in class DynamicRoleProvider

Get the roles from the provider

DynamicRoleProvider::getRole() — Method in class DynamicRoleProvider

Get a role object by name.

DynamicRoleProvider::getPermissionsArray() — Method in class DynamicRoleProvider

Get an associative array of role name => permissions using the provided configuration.

DynamicRoleProvider::getRolesForSettings() — Method in class DynamicRoleProvider

Given a settings array, return the appropriate roles.

DynamicRoleProviderFactory::getPermissionProviderPluginManager() — Method in class DynamicRoleProviderFactory

Create the supporting plugin manager.

DynamicRoleProviderFactory::getPermissionConfiguration() — Method in class DynamicRoleProviderFactory

Get a configuration array.

PermissionDeniedManager::getDeniedControllerBehavior() — Method in class PermissionDeniedManager

Get behavior to apply when a controller denies a permission.

PermissionDeniedManager::getDeniedTemplateBehavior() — Method in class PermissionDeniedManager

Get behavior to apply when a template denies a permission.

PermissionDeniedManager::getDeniedBehavior() — Method in class PermissionDeniedManager

Get permission denied logic

IpRange::getPermissions() — Method in class IpRange

Return an array of roles which may be granted the permission based on the options.

IpRegEx::getPermissions() — Method in class IpRegEx

Return an array of roles which may be granted the permission based on the options.

PermissionProviderInterface::getPermissions() — Method in class PermissionProviderInterface

Return an array of roles which may be granted the permission based on the options.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

Role::getPermissions() — Method in class Role

Return an array of roles which may be granted the permission based on the options.

ServerParam::getPermissions() — Method in class ServerParam

Return an array of roles which may be granted the permission based on the options.

Shibboleth::getPermissions() — Method in class Shibboleth

Return an array of roles which may be granted the permission based on the options.

User::getPermissions() — Method in class User

Return an array of roles which may be granted the permission based on the options.

Username::getPermissions() — Method in class Username

Return an array of roles which may be granted the permission based on the options.

AbstractBase::getValidationType() — Method in class AbstractBase

Get validation type for phone numbers

Clickatell::getCarriers() — Method in class Clickatell

Get a list of carriers supported by the module. Returned as an array of associative arrays indexed by carrier ID and containing "name" and "domain" keys.

Clickatell::getApiUsername() — Method in class Clickatell

Get API username.

Clickatell::getApiPassword() — Method in class Clickatell

Get API password.

Clickatell::getApiId() — Method in class Clickatell

Get API ID.

Clickatell::getApiUrl() — Method in class Clickatell

Get API URL.

Mailer::getCarriers() — Method in class Mailer

Get a list of carriers supported by the module. Returned as an array of associative arrays indexed by carrier ID and containing "name" and "domain" keys.

SMSInterface::getValidationType() — Method in class SMSInterface

Get validation type for phone numbers

SMSInterface::getCarriers() — Method in class SMSInterface

Get a list of carriers supported by the module. Returned as an array of associative arrays indexed by carrier ID and containing "name" and "domain" keys.

BackendManager::getBackendRegistry() — Method in class BackendManager

Return backend registry.

BackendManager::get() — Method in class BackendManager

Return named backend.

BackendManagerFactory::getRegistry() — Method in class BackendManagerFactory

Create the backend registry.

BackendRegistry::getExpectedInterface() — Method in class BackendRegistry

Return the name of the base class or interface that plug-ins must conform to.

FacetCache::getCacheNamespace() — Method in class FacetCache

Get the namespace to use for caching facets.

FacetCache::getCacheKey() — Method in class FacetCache

Get the cache key for the provided method.

FacetCache::getFacetResults() — Method in class FacetCache

Perform the actual facet lookup.

FacetCache::getList() — Method in class FacetCache

Return facet information. This data may come from the cache.

FacetCache::getResults() — Method in class FacetCache

Get results object used to retrieve facets.

FacetCacheFactory::getResults() — Method in class FacetCacheFactory

Create a results object.

HierarchicalFacetHelperInterface::getFilterStringParts() — Method in class HierarchicalFacetHelperInterface

Format a filter string in parts suitable for displaying or translation

Options::getSpecialAdvancedFacets() — Method in class Options

Get string listing special advanced facet types.

Options::getAdvancedHandlers() — Method in class Options

Basic 'getter' for advanced search handlers.

Options::getBasicHandlers() — Method in class Options

Basic 'getter' for basic search handlers.

Options::getHandlerForLabel() — Method in class Options

Given a label from the configuration file, return the name of the matching handler (basic checked first, then advanced); return the default handler if no match is found.

Options::getLabelForBasicHandler() — Method in class Options

Given a basic handler name, return the corresponding label (or false if none found):

Options::getDefaultHandler() — Method in class Options

Get default search handler.

Options::getDefaultLimit() — Method in class Options

Get default limit setting.

Options::getLimitOptions() — Method in class Options

Get an array of limit options.

Options::getFacetsIni() — Method in class Options

Get the name of the ini file used for configuring facet parameters in this object.

Options::getMainIni() — Method in class Options

Get the name of the ini file used for loading primary settings in this object.

Options::getSearchIni() — Method in class Options

Get the name of the ini file used for configuring search parameters in this object.

Options::getSortOptions() — Method in class Options

Get an array of sort options.

Options::getFacetSortOptions() — Method in class Options

Get an array of sort options for a facet.

Options::getDefaultSortByHandler() — Method in class Options

Get the default sort option for the specified search handler.

Options::getRssSort() — Method in class Options

Return the sorting value for RSS mode

Options::getDefaultView() — Method in class Options

Get default view setting.

Options::getViewOptions() — Method in class Options

Get an array of view options.

Options::getDefaultFacetDelimiter() — Method in class Options

Returns the defaultFacetDelimiter value.

Options::getDelimitedFacets() — Method in class Options

Get a list of delimited facets

Options::getTranslatedFacets() — Method in class Options

Get a list of facets that are subject to translation.

Options::getTextDomainForTranslatedFacet() — Method in class Options

Look up the text domain for use when translating a particular facet field.

Options::getFormatForTranslatedFacet() — Method in class Options

Look up the format for use when translating a particular facet field.

Options::getHierarchicalFacets() — Method in class Options

Get hierarchical facet fields.

Options::getHierarchicalFacetSeparators() — Method in class Options

Get hierarchical facet separators.

Options::getHumanReadableFieldName() — Method in class Options

Translate a field name to a displayable string for rendering a query in human-readable format:

Options::getListViewOption() — Method in class Options

Get a string of the listviewOption (full or tab).

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getSearchHomeAction() — Method in class Options

Return the route name for the search home action.

Options::getAdvancedSearchAction() — Method in class Options

Return the route name of the action used for performing advanced searches.

Options::getFacetListAction() — Method in class Options

Return the route name for the facet list action. Returns false to cover unimplemented support.

Options::getVersionsAction() — Method in class Options

Return the route name for the versions search action. Returns false to cover unimplemented support.

Options::getDefaultFilters() — Method in class Options

Get default filters to apply to an empty search.

Options::getRetainFilterSetting() — Method in class Options

Should filter settings be retained across searches by default?

Options::getShards() — Method in class Options

Get an associative array of available shards (key = internal VuFind ID for this shard; value = details needed to connect to shard; empty for non-sharded data sources).

Options::getDefaultSelectedShards() — Method in class Options

Get an array of default selected shards (values correspond with keys returned by getShards().

Options::getVisibleSearchResultLimit() — Method in class Options

If there is a limit to how many search results a user can access, this method will return that limit. If there is no limit, this will return -1.

Options::getAPISettings() — Method in class Options

Load all API-related settings from the relevant ini file(s).

Options::getRecommendationSettings() — Method in class Options

Load all recommendation settings from the relevant ini file. Returns an associative array where the key is the location of the recommendations (top or side) and the value is the settings found in the file (which may be either a single string or an array of strings).

Options::getSearchClassId() — Method in class Options

Get the identifier used for naming the various search classes in this family.

Options::getSpellingNormalizer() — Method in class Options

Return the callback used for normalization within this backend.

Params::getOptions() — Method in class Params

Get the search options object.

Params::getSearchClassId() — Method in class Params

Get the identifier used for naming the various search classes in this family.

Params::getDefaultSort() — Method in class Params

Return the default sorting value

Params::getLimit() — Method in class Params

Return the current limit value

Params::getPage() — Method in class Params

Get the page value

Params::getSort() — Method in class Params

Return the sorting value

Params::getSearchHandler() — Method in class Params

Return the selected search handler (null for complex searches which have no single handler)

Params::getSearchType() — Method in class Params

Return the search type (i.e. basic or advanced)

Params::getView() — Method in class Params

Return the value for which search view we use

Params::getDisplayQuery() — Method in class Params

Build a string for onscreen display showing the query used in the search (not the filters).

Params::getAliasesForFacetField() — Method in class Params

Given a facet field, return an array containing all aliases of that field.

Params::getFacetOperator() — Method in class Params

Get facet operator for the specified field

Params::getFacetLabel() — Method in class Params

Get a user-friendly string to describe the provided facet field.

Params::getFacetConfig() — Method in class Params

Get the current facet configuration.

Params::getRawFilters() — Method in class Params

Get the raw filter list.

Params::getFilterList() — Method in class Params

Return an array structure containing information about all current filters.

Params::getFiltersAsQueryParams() — Method in class Params

Get the filter list as a query parameter array.

Params::getFacetValueRawDisplayText() — Method in class Params

Get a display text for a facet field.

Params::getCheckboxFacetValues() — Method in class Params

Get a formatted list of checkbox filter values ($field => array of values).

Params::getCheckboxFacets() — Method in class Params

Get information on the current state of the boolean checkbox facets.

Params::getRawCheckboxFacets() — Method in class Params

Return checkbox facets without any processing

Params::getHiddenFilters() — Method in class Params

Get hidden filters grouped by field like normal filters.

Params::getHiddenFiltersAsQueryParams() — Method in class Params

Get the hidden filter list as a query parameter array.

Params::getDisplayQueryWithReplacedTerm() — Method in class Params

Return a query string for the current search with a search term replaced.

Params::getViewList() — Method in class Params

Basic 'getter' for list of available view options.

Params::getLimitList() — Method in class Params

Return a list of urls for possible limits, along with which option should be currently selected.

Params::getSortList() — Method in class Params

Return a list of urls for sorting, along with which option should be currently selected.

Params::getQueryIDLimit() — Method in class Params

Get the maximum number of IDs that may be sent to setQueryIDs (-1 for no limit).

Params::getSelectedShards() — Method in class Params

Get an array of the names of all selected shards. These should correspond with keys in the array returned by the option class's getShards() method.

Params::getOverrideQuery() — Method in class Params

Get the override query

Params::getQuery() — Method in class Params

Return search query object.

Results::getParams() — Method in class Results

Get the search parameters object.

Results::getOptions() — Method in class Results

Get the search options object.

Results::getUrlQueryHelperOptions() — Method in class Results

Options for UrlQueryHelper

Results::getUrlQuery() — Method in class Results

Get the URL helper for this object.

Results::getFacetList() — Method in class Results

Returns the stored list of facets for the last search

Results::getSpellingSuggestions() — Method in class Results

Get spelling suggestion information.

Results::getResultTotal() — Method in class Results

Get total count of records in the result set (not just current page).

Results::getStartRecord() — Method in class Results

Get record number for start of range represented by current result set.

Results::getEndRecord() — Method in class Results

Get record number for end of range represented by current result set.

Results::getResults() — Method in class Results

Basic 'getter' for search results.

Results::getErrors() — Method in class Results

Basic 'getter' for errors.

Results::getBackendId() — Method in class Results

Basic 'getter' of search backend identifier.

Results::getSearchId() — Method in class Results

Basic 'getter' for ID of saved search.

Results::getNotificationFrequency() — Method in class Results

How frequently (in days) will the current user be notified about updates to these search results (0 = never)?

Results::getQuerySpeed() — Method in class Results

Basic 'getter' for query speed.

Results::getStartTime() — Method in class Results

Basic 'getter' for query start time.

Results::getPaginator() — Method in class Results

Get a paginator for the result set.

Results::getRawSuggestions() — Method in class Results

Basic 'getter' for suggestion list.

Results::getExtraData() — Method in class Results

Get extra data for the search.

Results::getRecommendations() — Method in class Results

Get an array of recommendation objects for augmenting the results display.

Results::getSearchService() — Method in class Results

Return search service.

Results::getUrlQueryHelperFactory() — Method in class Results

Get URL query helper factory

Results::getFullFieldFacets() — Method in class Results

Get complete facet counts for several index fields

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getAdvancedSearchAction() — Method in class Options

Return the route name of the action used for performing advanced searches.

Options::getFacetListAction() — Method in class Options

Return the route name for the facet list action. Returns false to cover unimplemented support.

Params::getBackendParameters() — Method in class Params

Create search backend parameters for advanced features.

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getAdvancedSearchAction() — Method in class Options

Return the route name of the action used for performing advanced searches.

Results::getFacetList() — Method in class Results

Returns the stored list of facets for the last search

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getRecommendationSettings() — Method in class Options

Load all recommendation settings from the relevant ini file. Returns an associative array where the key is the location of the recommendations (top or side) and the value is the settings found in the file (which may be either a single string or an array of strings).

Results::getFacetList() — Method in class Results

Returns the stored list of facets for the last search

Options::getAdvancedHandlers() — Method in class Options

Basic 'getter' for advanced search handlers.

Options::getBasicHandlers() — Method in class Options

Basic 'getter' for basic search handlers.

Options::getDefaultHandler() — Method in class Options

Get default search handler.

Options::getSortOptions() — Method in class Options

Get an array of sort options.

Options::getDefaultLimit() — Method in class Options

Get default limit setting.

Options::getSearchMode() — Method in class Options

Obtain the set searchmode

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getView() — Method in class Options

Return the view associated with this configuration

Options::getModeOptions() — Method in class Options

Get an array of search mode options

Options::getDefaultMode() — Method in class Options

Get the default search mode

Options::getEdsView() — Method in class Options

Return the view associated with this configuration

Options::getDefaultExpanders() — Method in class Options

Return the expander ids that have the default on flag set in admin

Options::getAdvancedSearchAction() — Method in class Options

Return the route name of the action used for performing advanced searches.

Options::getApiProperty() — Method in class Options

Get the value of a property that is retrieved via the Info method and stored in a member property.

Options::getAvailableLimiters() — Method in class Options

Returns the available limiters

Options::getAdvancedLimiters() — Method in class Options

Returns the enabled limiters for the advanced search

Options::getAvailableExpanders() — Method in class Options

Returns the available expanders

Options::getLabelForCheckboxFilter() — Method in class Options

Get a translation string (if available) or else use a default

Options::getSearchScreenLimiters() — Method in class Options

Obtain limiters to display on the basic search screen

Options::getSearchScreenExpanders() — Method in class Options

Obtain expanders to display on the basic search screen

Options::getDefaultView() — Method in class Options

Get default view setting.

Options::getDefaultFilters() — Method in class Options

Get default filters to apply to an empty search.

Params::getBackendParameters() — Method in class Params

Create search backend parameters for advanced features.

Params::getView() — Method in class Params

Return the value for which search view we use

Params::getEdsView() — Method in class Params

Return the value for which search view we use

Params::getFullFacetSettings() — Method in class Params

Get the full facet settings stored by addFacet -- these may include extra parameters needed by the search results class.

Params::getFacetLabel() — Method in class Params

Get a user-friendly string to describe the provided facet field.

Params::getDateFacetSettings() — Method in class Params

Get the date facet settings stored by addFacet.

Params::getViewList() — Method in class Params

Basic 'getter' for list of available view options.

Params::getDisplayQuery() — Method in class Params

Override for build a string for onscreen display showing the query used in the search. It will include field level operators instead of group operators (Since EDS only uses one group.)

Params::getRawCheckboxFacets() — Method in class Params

Return checkbox facets without any processing

Results::getFacetList() — Method in class Results

Returns the stored list of facets for the last search

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getAdvancedSearchAction() — Method in class Options

Return the route name of the action used for performing advanced searches.

Params::getBackendParameters() — Method in class Params

Create search backend parameters for advanced features.

Results::getFacetList() — Method in class Results

Returns the stored list of facets for the last search

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Results::getFacetList() — Method in class Results

Returns the stored list of facets for the last search

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

AbstractSolrBackendFactory::getSolrCore() — Method in class AbstractSolrBackendFactory

Get the Solr core.

AbstractSolrBackendFactory::getSolrUrl() — Method in class AbstractSolrBackendFactory

Get the Solr URL.

AbstractSolrBackendFactory::getHiddenFilters() — Method in class AbstractSolrBackendFactory

Get all hidden filter settings.

AbstractSolrBackendFactory::getHttpOptions() — Method in class AbstractSolrBackendFactory

Get HTTP options for the client

AbstractSolrBackendFactory::getCreateRecordCallback() — Method in class AbstractSolrBackendFactory

Get the callback for creating a record.

AbstractSolrBackendFactory::getDeduplicationListener() — Method in class AbstractSolrBackendFactory

Get a deduplication listener for the backend

AbstractSolrBackendFactory::getCustomFilterListener() — Method in class AbstractSolrBackendFactory

Get a custom filter listener for the backend (or null if not needed).

AbstractSolrBackendFactory::getHierarchicalFacetListener() — Method in class AbstractSolrBackendFactory

Get a hierarchical facet listener for the backend

AbstractSolrBackendFactory::getInjectHighlightingListener() — Method in class AbstractSolrBackendFactory

Get a highlighting listener for the backend

AbstractSolrBackendFactory::getInjectConditionalFilterListener() — Method in class AbstractSolrBackendFactory

Get a Conditional Filter Listener

AbstractSolrBackendFactory::getDefaultParametersListener() — Method in class AbstractSolrBackendFactory

Get a default parameters listener for the backend

PrimoBackendFactory::getInjectOnCampusListener() — Method in class PrimoBackendFactory

Get a OnCampus Listener

PrimoBackendFactory::getPermissionHandler() — Method in class PrimoBackendFactory

Get a PrimoPermissionHandler

Search2BackendFactory::getCreateRecordCallback() — Method in class Search2BackendFactory

Get the callback for creating a record.

SharedListenersTrait::getHideFacetValueListener() — Method in class SharedListenersTrait

Get a hide facet value listener for the backend

SolrAuthBackendFactory::getSolrCore() — Method in class SolrAuthBackendFactory

Get the Solr core.

SolrAuthBackendFactory::getCreateRecordCallback() — Method in class SolrAuthBackendFactory

Get the callback for creating a record.

SolrDefaultBackendFactory::getSolrCore() — Method in class SolrDefaultBackendFactory

Get the Solr core.

SolrDefaultBackendFactory::getCreateRecordCallback() — Method in class SolrDefaultBackendFactory

Get the callback for creating a record.

SolrReservesBackendFactory::getCreateRecordCallback() — Method in class SolrReservesBackendFactory

Get the callback for creating a record.

SolrWebBackendFactory::getSolrCore() — Method in class SolrWebBackendFactory

Get the Solr core.

SolrWebBackendFactory::getSolrUrl() — Method in class SolrWebBackendFactory

Get the Solr URL.

SolrWebBackendFactory::getCreateRecordCallback() — Method in class SolrWebBackendFactory

Get the callback for creating a record.

UrlQueryHelperFactory::getDefaults() — Method in class UrlQueryHelperFactory

Extract default settings from the search parameters.

UrlQueryHelperFactory::getUrlParams() — Method in class UrlQueryHelperFactory

Extract URL query parameters from VuFind search parameters.

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getRecommendationSettings() — Method in class Options

Load all recommendation settings from the relevant ini file. Returns an associative array where the key is the location of the recommendations (top or side) and the value is the settings found in the file (which may be either a single string or an array of strings).

Results::getFacetList() — Method in class Results

Returns the stored list of facets for the last search

Results::getTagFilters() — Method in class Results

Get an array of tags being applied as filters.

Results::getListObject() — Method in class Results

Get the list object associated with the current search (null if no list selected).

History::getSearchHistory() — Method in class History

Get the user's saved and temporary search histories.

History::getScheduleOptions() — Method in class History

Get a list of scheduling options (empty list if scheduling disabled).

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getAdvancedSearchAction() — Method in class Options

Return the route name of the action used for performing advanced searches.

Results::getFacetList() — Method in class Results

Returns the stored list of facets for the last search

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getRecommendationSettings() — Method in class Options

Load all recommendation settings from the relevant ini file. Returns an associative array where the key is the location of the recommendations (top or side) and the value is the settings found in the file (which may be either a single string or an array of strings).

Params::getDisplayQuery() — Method in class Params

Build a string for onscreen display.

Params::getHiddenFilters() — Method in class Params

Return record ids as a hidden filter list so that it is properly stored when the search is represented as an URL or stored in the database.

Params::getRecordsToRequest() — Method in class Params

Get list of records to display.

Results::getFacetList() — Method in class Results

Returns the stored list of facets for the last search

NormalizedSearch::getRawResults() — Method in class NormalizedSearch

Get raw search object provided to constructor.

NormalizedSearch::getMinified() — Method in class NormalizedSearch

Get minified version of search.

NormalizedSearch::getNormalizedResults() — Method in class NormalizedSearch

Get normalized version of search object.

NormalizedSearch::getUrl() — Method in class NormalizedSearch

Get search URL from normalized search object.

NormalizedSearch::getChecksum() — Method in class NormalizedSearch

Get checksum of normalized search URL.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

FacetLimitTrait::getHierarchicalFacetLimit() — Method in class FacetLimitTrait

Get current limit for hierarchical facets

FacetLimitTrait::getFacetLimitForField() — Method in class FacetLimitTrait

Get the facet limit for the specified field.

FacetRestrictionsTrait::getFacetPrefixForField() — Method in class FacetRestrictionsTrait

Get the facet prefix for the specified field.

FacetRestrictionsTrait::getFacetMatchesForField() — Method in class FacetRestrictionsTrait

Get the facet matches for the specified field.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getAdvancedSearchAction() — Method in class Options

Return the route name of the action used for performing advanced searches.

Params::getBackendParameters() — Method in class Params

Create search backend parameters for advanced features.

Results::getFacetList() — Method in class Results

Returns the stored list of facets for the last search

InjectOnCampusListener::getOnCampus() — Method in class InjectOnCampusListener

Determines, which value is needed for the onCampus parameter

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getAdvancedSearchAction() — Method in class Options

Return the route name of the action used for performing advanced searches.

Options::getAdvancedOperators() — Method in class Options

Basic 'getter' for Primo advanced search operators.

Params::getBackendParameters() — Method in class Params

Create search backend parameters for advanced features.

Params::getFacetValueRawDisplayText() — Method in class Params

Get a display text for a facet field.

Params::getFilterSettings() — Method in class Params

Return the current filters as an array

PrimoPermissionHandler::getInstCode() — Method in class PrimoPermissionHandler

Determine the institution code Returns false, if no institution can get set

PrimoPermissionHandler::getInstCodes() — Method in class PrimoPermissionHandler

Gets all possible institution codes from config file

PrimoPermissionHandler::getDefaultCode() — Method in class PrimoPermissionHandler

Determine the default institution code Returns false, if no default code has been set

PrimoPermissionHandler::getDefaultOnCampusRule() — Method in class PrimoPermissionHandler

Determine the default onCampus Rule

PrimoPermissionHandler::getOnCampusRule() — Method in class PrimoPermissionHandler

Determine a onCampus Rule for a certain code

Results::getFacetList() — Method in class Results

Returns the stored list of facets for the last search

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

FacetCache::getCacheNamespace() — Method in class FacetCache

Get the namespace to use for caching facets.

Options::getFacetListAction() — Method in class Options

Return the route name for the facet list action. Returns false to cover unimplemented support.

Options::getVersionsAction() — Method in class Options

Return the route name for the versions search action or false if disabled.

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getAdvancedSearchAction() — Method in class Options

Return the route name of the action used for performing advanced searches.

SearchRunner::getEventManager() — Method in class SearchRunner

Return EventManager instance.

SearchTabsHelper::getHiddenFilters() — Method in class SearchTabsHelper

Get an array of hidden filters

SearchTabsHelper::getTabConfig() — Method in class SearchTabsHelper

Get the tab configuration

SearchTabsHelper::getTabFilterConfig() — Method in class SearchTabsHelper

Get the tab filters

SearchTabsHelper::getTabPermissionConfig() — Method in class SearchTabsHelper

Get the tab permissions

SearchTabsHelper::getSettings() — Method in class SearchTabsHelper

Get the tab details

SearchTabsHelper::getDefaultTabHiddenFilters() — Method in class SearchTabsHelper

Get an array of hidden filters for the default tab of the given search class

Options::getFacetListAction() — Method in class Options

Return the route name for the facet list action. Returns false to cover unimplemented support.

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getAdvancedSearchAction() — Method in class Options

Return the route name of the action used for performing advanced searches.

Options::getFacetListAction() — Method in class Options

Return the route name for the facet list action. Returns false to cover unimplemented support.

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getRecommendationSettings() — Method in class Options

Load all recommendation settings from the relevant ini file. Returns an associative array where the key is the location of the recommendations (top or side) and the value is the settings found in the file (which may be either a single string or an array of strings).

Options::getFacetListAction() — Method in class Options

Return the route name for the facet list action. Returns false to cover unimplemented support.

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getRecommendationSettings() — Method in class Options

Load all recommendation settings from the relevant ini file. Returns an associative array where the key is the location of the recommendations (top or side) and the value is the settings found in the file (which may be either a single string or an array of strings).

Params::getDisplayQuery() — Method in class Params

Build a string for onscreen display showing the query used in the search (not the filters).

Results::getUrlQueryHelperOptions() — Method in class Results

Options for UrlQueryHelper

Options::getFacetListAction() — Method in class Options

Return the route name for the facet list action. Returns false to cover unimplemented support.

Options::getRecommendationSettings() — Method in class Options

Load all recommendation settings from the relevant ini file. Returns an associative array where the key is the location of the recommendations (top or side) and the value is the settings found in the file (which may be either a single string or an array of strings).

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Params::getCollectionField() — Method in class Params

Get collection field

Params::getCollectionId() — Method in class Params

Get collection id

Options::getFacetListAction() — Method in class Options

Return the route name for the facet list action. Returns false to cover unimplemented support.

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getAdvancedSearchAction() — Method in class Options

Return the route name of the action used for performing advanced searches.

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getAdvancedSearchAction() — Method in class Options

Return the route name of the action used for performing advanced searches.

Options::getFacetListAction() — Method in class Options

Return the route name for the facet list action. Returns false to cover unimplemented support.

DeduplicationListener::getActiveRecordSources() — Method in class DeduplicationListener

Get currently active record sources.

FacetCache::getCacheNamespace() — Method in class FacetCache

Get the namespace to use for caching facets.

FacetCacheFactory::getResults() — Method in class FacetCacheFactory

Create a results object with hidden filters pre-populated.

HierarchicalFacetHelper::getFilterStringParts() — Method in class HierarchicalFacetHelper

Format a filter string in parts suitable for displaying or translation

MultiIndexListener::getFields() — Method in class MultiIndexListener

Return array of fields to strip.

MultiIndexListener::getSearchSpecs() — Method in class MultiIndexListener

Strip fields from base search specs.

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getAdvancedSearchAction() — Method in class Options

Return the route name of the action used for performing advanced searches.

Options::getFacetListAction() — Method in class Options

Return the route name for the facet list action. Returns false to cover unimplemented support.

Options::getVersionsAction() — Method in class Options

Return the route name for the versions search action or false if disabled.

Options::getEmptySearchRelevanceOverride() — Method in class Options

Get the relevance sort override for empty searches.

Options::getSortTieBreaker() — Method in class Options

Get the field to be used as a sort tie-breaker.

Params::getFilterSettings() — Method in class Params

Return the current filters as an array of strings ['field:filter']

Params::getFacetSettings() — Method in class Params

Return current facet configurations

Params::getQueryIDLimit() — Method in class Params

Get the maximum number of IDs that may be sent to setQueryIDs (-1 for no limit).

Params::getBackendParameters() — Method in class Params

Create search backend parameters for advanced features.

Params::getPivotFacets() — Method in class Params

Get pivot facet information for visual facets

Params::getCheckboxFacets() — Method in class Params

Get information on the current state of the boolean checkbox facets.

Results::getSpellingProcessor() — Method in class Results

Get spelling processor.

Results::getCursorMark() — Method in class Results

Get cursorMark.

Results::getSpellingSuggestions() — Method in class Results

Turn the list of spelling suggestions into an array of urls for on-screen use to implement the suggestions.

Results::getFacetList() — Method in class Results

Returns the stored list of facets for the last search

Results::getPartialFieldFacets() — Method in class Results

Get complete facet counts for several index fields

Results::getPivotFacetList() — Method in class Results

Returns data on pivot facets for the last search

SpellingProcessor::getSpellingLimit() — Method in class SpellingProcessor

Get the spelling limit.

SpellingProcessor::getSuggestions() — Method in class SpellingProcessor

Get raw spelling suggestions for a query.

ErrorListener::getResponseBodyMediaType() — Method in class ErrorListener

Return normalized media type identifier.

FacetCache::getCacheNamespace() — Method in class FacetCache

Get the namespace to use for caching facets.

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getAdvancedSearchAction() — Method in class Options

Return the route name of the action used for performing advanced searches.

Options::getFacetListAction() — Method in class Options

Return the route name for the facet list action. Returns false to cover unimplemented support.

Options::getEmptySearchRelevanceOverride() — Method in class Options

Get the relevance sort override for empty searches.

Options::getMaxTopicRecommendations() — Method in class Options

Get the maximum number of topic recommendations (false for none)

Params::getFullFacetSettings() — Method in class Params

Get the full facet settings stored by addFacet -- these may include extra parameters needed by the search results class.

Params::getDateFacetSettings() — Method in class Params

Get the date facet settings stored by addFacet.

Params::getFacetLabel() — Method in class Params

Get a user-friendly string to describe the provided facet field.

Params::getCheckboxFacets() — Method in class Params

Get information on the current state of the boolean checkbox facets.

Params::getBackendParameters() — Method in class Params

Create search backend parameters for advanced features.

Params::getBackendFacetParameters() — Method in class Params

Set up facets based on VuFind settings.

Results::getFacetList() — Method in class Results

Returns the stored list of facets for the last search

Results::getSpellingSuggestions() — Method in class Results

Turn the list of spelling suggestions into an array of urls for on-screen use to implement the suggestions.

Results::getBestBets() — Method in class Results

Get best bets from Summon, if any.

Results::getDatabaseRecommendations() — Method in class Results

Get database recommendations from Summon, if any.

Results::getTopicRecommendations() — Method in class Results

Get topic recommendations from Summon, if any.

Results::getPartialFieldFacets() — Method in class Results

Get complete facet counts for several index fields

Options::getAdvancedSearchAction() — Method in class Options

Return the route name of the action used for performing advanced searches.

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getRecommendationSettings() — Method in class Options

Load all recommendation settings from the relevant ini file. Returns an associative array where the key is the location of the recommendations (top or side) and the value is the settings found in the file (which may be either a single string or an array of strings).

Results::getFacetList() — Method in class Results

Returns the stored list of facets for the last search

UrlQueryHelper::getBasicSearchParam() — Method in class UrlQueryHelper

Get the name of the basic search param.

UrlQueryHelper::getDefault() — Method in class UrlQueryHelper

Look up a default value in the internal configuration array.

UrlQueryHelper::getParamsWithConfiguredDefaults() — Method in class UrlQueryHelper

Get an array of field names with configured defaults; this is a useful way to identify custom query parameters added through setDefaultParameter().

UrlQueryHelper::getParamArray() — Method in class UrlQueryHelper

Get an array of URL parameters.

UrlQueryHelper::getParams() — Method in class UrlQueryHelper

Get the current search parameters as a GET query.

UrlQueryHelper::getAliasesForFacetField() — Method in class UrlQueryHelper

Given a facet field, return an array containing all aliases of that field.

Options::getSearchAction() — Method in class Options

Return the route name for the search results action.

Options::getAdvancedSearchAction() — Method in class Options

Return the route name of the action used for performing advanced searches.

Params::getBackendParameters() — Method in class Params

Create search backend parameters for advanced features.

Results::getFacetList() — Method in class Results

Returns the stored list of facets for the last search

CspHeaderGenerator::getHeader() — Method in class CspHeaderGenerator

Create CSP header base on given configuration

NonceGenerator::getNonce() — Method in class NonceGenerator

Generates a random nonce parameter.

AbstractPluginFactory::getClassName() — Method in class AbstractPluginFactory

Get the name of a class for a given plugin name.

AbstractPluginManager::getExpectedInterface() — Method in class AbstractPluginManager

Return the name of the base class or interface that plug-ins must conform to.

AbstractPluginManagerFactory::getConfigKey() — Method in class AbstractPluginManagerFactory

Determine the configuration key for the specified class name.

LowerCaseServiceNameTrait::get() — Method in class LowerCaseServiceNameTrait

Retrieve a plugin

LowerCaseServiceNameTrait::getNormalizedServiceName() — Method in class LowerCaseServiceNameTrait

Hack for backward compatibility with services defined under ServiceManager v2, when service names were case-insensitive.

MarkdownFactory::getEnvironment() — Method in class MarkdownFactory

Get Markdown environment.

MarkdownFactory::getBaseConfig() — Method in class MarkdownFactory

Get Markdown base config.

MarkdownFactory::getExtensionClass() — Method in class MarkdownFactory

Get full class name for given extension

MarkdownFactory::getConfigForExtension() — Method in class MarkdownFactory

Get config for given extension

MarkdownFactory::getConfigForCoreExtension() — Method in class MarkdownFactory

Get config for core extension

ReCaptcha::getHtml() — Method in class ReCaptcha

Get the HTML code for the captcha

AbstractBase::gc() — Method in class AbstractBase

The garbage collector, this is executed when the session garbage collector is executed and takes the max session lifetime as its only parameter.

Database::gc() — Method in class Database

The garbage collector, this is executed when the session garbage collector is executed and takes the max session lifetime as its only parameter.

File::gc() — Method in class File

The garbage collector, this is executed when the session garbage collector is executed and takes the max session lifetime as its only parameter.

ManagerFactory::getOptions() — Method in class ManagerFactory

Build the options array.

ManagerFactory::getHandler() — Method in class ManagerFactory

Set up the session handler by retrieving all the pieces from the service manager and injecting appropriate dependencies.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

RedisFactory::getConnection() — Method in class RedisFactory

Given a configuration, build the client object.

AbstractFile::getEntry() — Method in class AbstractFile

Translate a URL into an appropriate entry for this sitemap file.

AbstractFile::getCount() — Method in class AbstractFile

Get the count of items

AbstractFile::getExtraNamespaces() — Method in class AbstractFile

Get any extra namespace declarations needed for the sitemap

GeneratorClass in namespace VuFind\Sitemap

Class for generating sitemaps

Generator::getTime() — Method in class Generator

Get the current microtime, formatted to a number.

Generator::generate() — Method in class Generator

Generate the sitemaps based on settings established by the constructor.

Generator::generateWithPlugins() — Method in class Generator

Generate sitemaps from all mandatory and configured plugins

Generator::getWarnings() — Method in class Generator

Get array of warning messages thrown during build.

Generator::getNewSitemapIndex() — Method in class Generator

Get a fresh SitemapIndex object.

Generator::getNewSitemap() — Method in class Generator

Get a fresh Sitemap object.

Generator::getFilenameForPage() — Method in class Generator

Get the filename for the specified page number or name.

Generator::getBaseSitemapIndexUrl() — Method in class Generator

Get the base URL for sitemap index files

Generator::getPlugin() — Method in class Generator

Create and setup a plugin

Generator::getSitemapLanguages() — Method in class Generator

Get languages for a sitemap

GeneratorFactoryClass in namespace VuFind\Sitemap

Sitemap Generator factory.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

AbstractGeneratorPlugin::getFrequency() — Method in class AbstractGeneratorPlugin

Get update frequency. Empty string implies that the default from sitemap configuration should be used.

AbstractGeneratorPlugin::getSitemapName() — Method in class AbstractGeneratorPlugin

Get the name of the sitemap used to create the sitemap file. This will be appended to the configured base name, and may be blank to use the base name without a suffix.

AbstractGeneratorPlugin::getUrls() — Method in class AbstractGeneratorPlugin

Generate urls for the sitemap.

ContentPages::getSitemapName() — Method in class ContentPages

Get the name of the sitemap used to create the sitemap file. This will be appended to the configured base name, and may be blank to use the base name without a suffix.

ContentPages::getUrls() — Method in class ContentPages

Generate urls for the sitemap.

GeneratorPluginInterfaceClass in namespace VuFind\Sitemap\Plugin

Interface for sitemap generator plugins

GeneratorPluginInterface::getSitemapName() — Method in class GeneratorPluginInterface

Get the name of the sitemap used to create the sitemap file. This will be appended to the configured base name, and may be blank to use the base name without a suffix.

GeneratorPluginInterface::getFrequency() — Method in class GeneratorPluginInterface

Get update frequency. Empty string implies that the default from sitemap configuration should be used.

GeneratorPluginInterface::getUrls() — Method in class GeneratorPluginInterface

Generate urls for the sitemap.

Index::getSitemapName() — Method in class Index

Get the name of the sitemap used to create the sitemap file. This will be appended to the configured base name, and may be blank to use the base name without a suffix.

Index::getUrls() — Method in class Index

Generate urls for the sitemap.

IndexFactory::getBackendSettings() — Method in class IndexFactory

Process backend configuration into a convenient array.

IndexFactory::getIdFetcher() — Method in class IndexFactory

Get the helper object for generating sitemaps through the search service.

AbstractIdFetcher::getInitialOffset() — Method in class AbstractIdFetcher

Get the initial offset to seed the search process

AbstractIdFetcher::getIdsFromBackend() — Method in class AbstractIdFetcher

Retrieve a batch of IDs. Returns an array with two possible keys: ids (the latest set of retrieved IDs) and nextOffset (an offset which can be passed to the next call to this function to retrieve the next page). When all IDs have been retrieved, the nextOffset value MUST NOT be included in the return array.

CursorMarkIdFetcher::getInitialOffset() — Method in class CursorMarkIdFetcher

Get the initial offset to seed the search process

CursorMarkIdFetcher::getIdsFromBackend() — Method in class CursorMarkIdFetcher

Retrieve a batch of IDs. Returns an array with two possible keys: ids (the latest set of retrieved IDs) and nextOffset (an offset which can be passed to the next call to this function to retrieve the next page). When all IDs have been retrieved, the nextOffset value MUST NOT be included in the return array.

TermsIdFetcher::getInitialOffset() — Method in class TermsIdFetcher

Get the initial offset to seed the search process

TermsIdFetcher::getIdsFromBackend() — Method in class TermsIdFetcher

Retrieve a batch of IDs. Returns an array with two possible keys: ids (the latest set of retrieved IDs) and nextOffset (an offset which can be passed to the next call to this function to retrieve the next page). When all IDs have been retrieved, the nextOffset value MUST NOT be included in the return array.

StartPage::getSitemapName() — Method in class StartPage

Get the name of the sitemap used to create the sitemap file. This will be appended to the configured base name, and may be blank to use the base name without a suffix.

StartPage::getUrls() — Method in class StartPage

Generate urls for the sitemap.

Sitemap::getEntry() — Method in class Sitemap

Translate a URL into an appropriate entry for this sitemap file.

Sitemap::getExtraNamespaces() — Method in class Sitemap

Get any extra namespace declarations needed for the sitemap

SitemapIndex::getEntry() — Method in class SitemapIndex

Translate a URL into an appropriate entry for this sitemap file.

VuFindHighlighter::getLink() — Method in class VuFindHighlighter

Return url with proxy

Database::getBase62Hash() — Method in class Database

Generate a short hash using the base62 algorithm (and write a row to the database).

Database::getGenericHash() — Method in class Database

Generate a short hash using the configured algorithm (and write a row to the database if the link is new).

Database::getShortHash() — Method in class Database

Given a URL, create a database entry (if necessary) and return the hash value for inclusion in the short URL.

PluginManager::getExpectedInterface() — Method in class PluginManager

Return the name of the base class or interface that plug-ins must conform to.

CsrfInterface::getHash() — Method in class CsrfInterface

Retrieve CSRF token

SessionCsrf::getTokenCount() — Method in class SessionCsrf

How many tokens are currently stored in the session?

AbstractSearch::getContainerClass() — Method in class AbstractSearch

Get the CSS classes for the container holding the suggestions.

Flashmessages::getClassForNamespace() — Method in class Flashmessages

Get the CSS class to correspond with a messenger namespace

Search::getContainerClass() — Method in class Search

Get the CSS classes for the container holding the suggestions.

AbstractJsStrings::getJSONFromArray() — Method in class AbstractJsStrings

Generate JSON from an array

AbstractJsStrings::getJSON() — Method in class AbstractJsStrings

Generate JSON from the internal strings

AbstractJsStrings::getScript() — Method in class AbstractJsStrings

Assign JSON to a variable.

AlphaBrowse::getUrl() — Method in class AlphaBrowse

Get link to browse results (or null if no valid URL available)

Auth::getManager() — Method in class Auth

Get manager

Auth::getCreateFields() — Method in class Auth

Render the create account form fields.

Auth::getILSPatron() — Method in class Auth

Get ILS patron record for the currently logged-in user.

Auth::getLoginFields() — Method in class Auth

Render the login form fields.

Auth::getLogin() — Method in class Auth

Render the login template.

Auth::getLoginDesc() — Method in class Auth

Render the login description template.

Auth::getNewPasswordForm() — Method in class Auth

Render the new password form template.

Auth::getPasswordRecoveryForm() — Method in class Auth

Render the password recovery form template.

Browse::getSolrField() — Method in class Browse

Get the Solr field associated with a particular browse action.

Captcha::getHtmlForCaptcha() — Method in class Captcha

Generate HTML of a single CAPTCHA (redirect to template)

Citation::getCitation() — Method in class Citation

Retrieve a citation in a particular format

Citation::getCitationAPA() — Method in class Citation

Get APA citation.

Citation::getCitationChicago() — Method in class Citation

Get Chicago Style citation.

Citation::getCitationMLA() — Method in class Citation

Get MLA citation.

Citation::getPageRange() — Method in class Citation

Construct page range portion of citation.

Citation::getMLANumberAndDate() — Method in class Citation

Construct volume/issue/date portion of MLA or Chicago Style citation.

Citation::getAPANumbersAndDate() — Method in class Citation

Construct volume/issue/date portion of APA citation. Returns an array with three elements: volume, issue and date (since these end up in different areas of the final citation, we don't return a single string, but since their determination is related, we need to do the work in a single function).

Citation::getAPATitle() — Method in class Citation

Get the full title for an APA citation.

Citation::getAPAAuthors() — Method in class Citation

Get an array of authors for an APA citation.

Citation::getEdition() — Method in class Citation

Get edition statement for inclusion in a citation. Shared by APA and MLA functionality.

Citation::getMLATitle() — Method in class Citation

Get the full title for an MLA citation.

Citation::getMLAAuthors() — Method in class Citation

Get an array of authors for an MLA or Chicago Style citation.

Citation::getPublisher() — Method in class Citation

Get publisher information (place: name) for inclusion in a citation.

Citation::getYear() — Method in class Citation

Get the year of publication for inclusion in a citation.

ClassBasedTemplateRendererTrait::getCachedClassTemplate() — Method in class ClassBasedTemplateRendererTrait

Resolve the class template file unless already cached and return the file name.

ClassBasedTemplateRendererTrait::getBriefClass() — Method in class ClassBasedTemplateRendererTrait

Helper to grab the end of the class name

ClassBasedTemplateRendererTrait::getTemplateWithClass() — Method in class ClassBasedTemplateRendererTrait

Helper to put the template path and class name together

Config::get() — Method in class Config

Get the specified configuration.

Config::getHoldingsItemLimit() — Method in class Config

Should we limit the number of items displayed on the full record?

Config::getRecordSubjectLimit() — Method in class Config

Should we limit the number of subjects displayed on the full record?

CookieConsent::getControlledVuFindServices() — Method in class CookieConsent

Get controlled VuFind services (services integrated into VuFind)

CookieConsent::getConsentInformation() — Method in class CookieConsent

Get information about user's given consent

CookieConsent::getConsentDialogConfig() — Method in class CookieConsent

Get configuration for the consent dialog

CookieConsent::getPlaceholders() — Method in class CookieConsent

Get placeholders for strings

CookieConsent::getDescriptionPlaceholders() — Method in class CookieConsent

Get placeholders for description translations

CookieConsent::getHostName() — Method in class CookieConsent

Get current host name

CookieConsent::getConsentRevision() — Method in class CookieConsent

Get current consent revision

CookieConsent::getCurrentConsent() — Method in class CookieConsent

Get current consent data

DateTime::getDisplayDateFormat() — Method in class DateTime

Builds an alphabetical help string based on the default display date format.

Flashmessages::getClassForNamespace() — Method in class Flashmessages

Get the CSS class to correspond with a messenger namespace

GeoCoordsClass in namespace VuFind\View\Helper\Root

GeoCoords view helper

$ GeoCoords#geoFieldProperty in class GeoCoords

Get geoField variable name

GeoCoords::getSearchUrl() — Method in class GeoCoords

Get search URL if geo search is enabled for the specified search class ID, false if disabled.

GeoCoordsFactoryClass in namespace VuFind\View\Helper\Root

GeoCoords helper factory.

GoogleAnalyticsClass in namespace VuFind\View\Helper\Root

GoogleAnalytics view helper

GoogleAnalytics::getRawJavascript() — Method in class GoogleAnalytics

Returns GA Javascript code.

GoogleAnalyticsFactoryClass in namespace VuFind\View\Helper\Root

GoogleAnalytics helper factory.

GoogleTagManagerClass in namespace VuFind\View\Helper\Root

GoogleTagManager view helper

$ GoogleTagManager#gtmContainerIdProperty in class GoogleTagManager

GTM Container ID (false if disabled)

GoogleTagManager::getHeadCode() — Method in class GoogleTagManager

Returns GTM code block meant for the element.

GoogleTagManager::getBodyCode() — Method in class GoogleTagManager

Returns GTM code block meant for the element.

GoogleTagManagerFactoryClass in namespace VuFind\View\Helper\Root

GoogleTagManager helper factory.

HelpText::getWarnings() — Method in class HelpText

Get warnings generated during rendering (if any).

Matomo::getSearchResults() — Method in class Matomo

Get Search Results if on a Results Page

Matomo::getCombinedSearchResults() — Method in class Matomo

Get Combined Search Results if on a Results Page

Matomo::getRecordDriver() — Method in class Matomo

Get Record Driver if on a Record Page

Matomo::getSearchCustomData() — Method in class Matomo

Get custom data for search results

Matomo::getRecordPageCustomData() — Method in class Matomo

Get custom data for record page

Matomo::getLightboxCustomData() — Method in class Matomo

Get custom data for lightbox actions

Matomo::getGenericCustomData() — Method in class Matomo

Get custom data for a generic page view

Matomo::getOpeningTrackingCode() — Method in class Matomo

Get the Initialization Part of the Tracking Code

Matomo::getClosingTrackingCode() — Method in class Matomo

Get the Finalization Part of the Tracking Code

Matomo::getPageUrl() — Method in class Matomo

Get the URL for the current page

Matomo::getCustomVarsCode() — Method in class Matomo

Convert a custom data array to JavaScript code

Matomo::getCustomDimensionsCode() — Method in class Matomo

Convert a custom data array to JavaScript dimensions code

Matomo::getTrackSearchCode() — Method in class Matomo

Get Site Search Tracking Code

Matomo::getTrackCombinedSearchCode() — Method in class Matomo

Get site search tracking code for combined search

Matomo::getTrackPageViewCode() — Method in class Matomo

Get Page View Tracking Code

Matomo::getTrackerUrl() — Method in class Matomo

Get Matomo tracker URL

Matomo::getTrackerJsUrl() — Method in class Matomo

Get Matomo tracker JS URL

Matomo::getInitFunctionName() — Method in class Matomo

Get name of JS init function

Metadata::getVocabularies() — Method in class Metadata

Get all active vocabularies for the current record.

Metadata::generateMetatags() — Method in class Metadata

Generate all metatags for RecordDriver and add to page

OpenUrl::getImageBasedLinkingMode() — Method in class OpenUrl

Public method to check ImageBased Linking mode

Permission::getAlternateContent() — Method in class Permission

Get content to display in place of blocked content

Piwik::getSearchResults() — Method in class Piwik

Get Search Results if on a Results Page

Piwik::getCombinedSearchResults() — Method in class Piwik

Get Combined Search Results if on a Results Page

Piwik::getRecordDriver() — Method in class Piwik

Get Record Driver if on a Record Page

Piwik::getSearchCustomVars() — Method in class Piwik

Get Custom Variables for Search Results

Piwik::getRecordPageCustomVars() — Method in class Piwik

Get Custom Variables for a Record Page

Piwik::getLightboxCustomVars() — Method in class Piwik

Get Custom Variables for lightbox actions

Piwik::getGenericCustomVars() — Method in class Piwik

Get Custom Variables for a Generic Page View

Piwik::getOpeningTrackingCode() — Method in class Piwik

Get the Initialization Part of the Tracking Code

Piwik::getCustomUrl() — Method in class Piwik

Get the custom URL of the Tracking Code

Piwik::getClosingTrackingCode() — Method in class Piwik

Get the Finalization Part of the Tracking Code

Piwik::getCustomVarsCode() — Method in class Piwik

Convert a Custom Variables Array to JavaScript Code

Piwik::getTrackSearchCode() — Method in class Piwik

Get Site Search Tracking Code

Piwik::getTrackCombinedSearchCode() — Method in class Piwik

Get Site Search Tracking Code for Combined Search

Piwik::getTrackPageViewCode() — Method in class Piwik

Get Page View Tracking Code

Record::getCoreMetadata() — Method in class Record

Render the core metadata area of the record view.

Record::getCollectionBriefRecord() — Method in class Record

Render the a brief record for use in collection mode.

Record::getCollectionMetadata() — Method in class Record

Render the core metadata area of the collection view.

Record::getExport() — Method in class Record

Export the record in the requested format. For legal values, see the export helper's getFormatsForRecord() method.

Record::getFormatClass() — Method in class Record

Get the CSS class used to properly render a format. (Note that this may not be used by every theme).

Record::getFormatList() — Method in class Record

Render a list of record formats.

Record::getLabelList() — Method in class Record

Render a list of record labels.

Record::getListEntry() — Method in class Record

Render an entry in a favorite list.

Record::getPreviews() — Method in class Record

Render previews (data and link) of the item if configured.

Record::getPreviewData() — Method in class Record

Render data needed to get previews.

Record::getPreviewLink() — Method in class Record

Render links to previews of the item if configured.

Record::getPreviewIds() — Method in class Record

Collects ISBN, LCCN, and OCLC numbers to use in calling preview APIs

Record::getTitleHtml() — Method in class Record

Get HTML to render a title.

Record::getLink() — Method in class Record

Render the link of the specified type.

Record::getTab() — Method in class Record

Render the contents of the specified record tab.

Record::getToolbar() — Method in class Record

Render a toolbar for use on the record view.

Record::getSearchResult() — Method in class Record

Render a search result for the specified view mode.

Record::getCheckbox() — Method in class Record

Render an HTML checkbox control for the current record.

Record::getCover() — Method in class Record

Render a cover for the current record.

Record::getPreviewCoverLinkSetting() — Method in class Record

Should cover images be linked to previews (when applicable) in the provided template context?

Record::getCoverDetails() — Method in class Record

Get the rendered cover plus some useful parameters.

Record::getCoverSize() — Method in class Record

Get the configured thumbnail size for record lists

Record::getThumbnailAlignment() — Method in class Record

Get the configured thumbnail alignment

Record::getQrCode() — Method in class Record

Generate a qrcode URL (return false if unsupported).

Record::getThumbnail() — Method in class Record

Generate a thumbnail URL (return false if unsupported).

Record::getUrlList() — Method in class Record

Get all URLs associated with the record. Returns an array of strings.

Record::getLinkDetails() — Method in class Record

Get all the links associated with this record. Returns an array of associative arrays each containing 'desc' and 'url' keys.

RecordDataFormatter::getData() — Method in class RecordDataFormatter

Create formatted key/value data based on a record driver and field spec.

RecordDataFormatter::getDefaults() — Method in class RecordDataFormatter

Get default configuration.

RecordDataFormatter::getLink() — Method in class RecordDataFormatter

Get a link associated with a value, or else return false if link does not apply.

RecordDataFormatterFactory::getAuthorFunction() — Method in class RecordDataFormatterFactory

Get the callback function for processing authors.

RecordDataFormatterFactory::getDefaultCollectionInfoSpecs() — Method in class RecordDataFormatterFactory

Get default specifications for displaying data in collection-info metadata.

RecordDataFormatterFactory::getDefaultCollectionRecordSpecs() — Method in class RecordDataFormatterFactory

Get default specifications for displaying data in collection-record metadata.

RecordDataFormatterFactory::getDefaultCoreSpecs() — Method in class RecordDataFormatterFactory

Get default specifications for displaying data in core metadata.

RecordDataFormatterFactory::getDefaultDescriptionSpecs() — Method in class RecordDataFormatterFactory

Get default specifications for displaying data in the description tab.

SpecBuilder::getArray() — Method in class SpecBuilder

Get the spec.

RecordLinker::getActionUrl() — Method in class RecordLinker

Given a record driver, get a URL for that record.

RecordLinker::getRequestUrl() — Method in class RecordLinker

Given a string or array of parts, build a request (e.g. hold) URL.

RecordLinker::getTabUrl() — Method in class RecordLinker

Given a record driver, get a URL for that record.

RecordLinker::getUrl() — Method in class RecordLinker

Get the default URL for a record.

RecordLinker::getBreadcrumbHtml() — Method in class RecordLinker

Given a record driver, generate HTML to link to the record from breadcrumbs.

RecordLinker::getChildRecordSearchUrl() — Method in class RecordLinker

Given a record driver, generate a URL to fetch all child records for it.

RecordLinker::getVersionsSearchUrl() — Method in class RecordLinker

Return search URL for all versions

RecordLinker::getSearchActionForSource() — Method in class RecordLinker

Given a record source ID, return the route name for searching its backend.

RecordLinker::getVersionsActionForSource() — Method in class RecordLinker

Given a record source ID, return the route name for version search with its backend.

Relais::getSearchLink() — Method in class Relais

Create a Relais search link from a record driver.

Related::getConfigForSource() — Method in class Related

Given a record source ID, return the appropriate related record configuration.

Related::getList() — Method in class Related

Get a list of related records modules.

ResultFeed::getDcDate() — Method in class ResultFeed

Support method to extract a date from a record driver. Return empty string if no valid match is found.

ResultFeed::getDateModified() — Method in class ResultFeed

Support method to extract modified date from a record driver object.

SearchBox::getOperatorCharacter() — Method in class SearchBox

Helper method: get special character to represent operator in filter

SearchBox::getFilterDetails() — Method in class SearchBox

Get an array of filter information for use by the "retain filters" feature of the search box. Returns an array of arrays with 'id' and 'value' keys used for generating hidden checkboxes.

SearchBox::getPlaceholderText() — Method in class SearchBox

Get placeholder text from config using the activeSearchClass as key

SearchBox::getHandlers() — Method in class SearchBox

Get an array of information on search handlers for use in generating a drop-down or hidden field. Returns an array of arrays with 'value', 'label', 'indent' and 'selected' keys.

SearchBox::getFilterCount() — Method in class SearchBox

Get number of active filters

SearchBox::getBasicHandlers() — Method in class SearchBox

Support method for getHandlers() -- load basic settings.

SearchBox::getCombinedHandlerConfig() — Method in class SearchBox

Support method for getCombinedHandlers() -- retrieve/validate configuration.

SearchBox::getAlphabrowseHandlers() — Method in class SearchBox

Support method for getCombinedHandlers(): get alphabrowse options.

SearchBox::getCombinedHandlers() — Method in class SearchBox

Support method for getHandlers() -- load combined settings.

SearchMemory::getLastSearchLink() — Method in class SearchMemory

If a previous search is recorded in the session, return a link to it; otherwise, return a blank string.

SearchMemory::getLastHiddenFilters() — Method in class SearchMemory

Retrieve the last hidden filters used.

SearchMemory::getLastLimit() — Method in class SearchMemory

Retrieve the last limit option used.

SearchMemory::getLastSort() — Method in class SearchMemory

Retrieve the last sort option used.

SearchMemory::getEditLink() — Method in class SearchMemory

Get the URL to edit the last search.

SearchMemory::getLastSearchParams() — Method in class SearchMemory

Retrieve the parameters of the last search by the search class

SearchTabs::getTabConfig() — Method in class SearchTabs

Determine information about search tabs

SearchTabs::getTabConfigForParams() — Method in class SearchTabs

Get the tab configuration

SearchTabs::getHiddenFilters() — Method in class SearchTabs

Get an array of hidden filters

SearchTabs::getCurrentHiddenFilterParams() — Method in class SearchTabs

Get current hidden filters as a string suitable for search URLs

Summon::getEndnoteFormat() — Method in class Summon

Export support function to convert Summon format to EndNote format.

Summon::getRefWorksFormat() — Method in class Summon

Export support function to convert Summon format to RefWorks format.

SyndeticsPlus::getScript() — Method in class SyndeticsPlus

Get the SyndeticsPlus Javascript loader.

UserList::getMode() — Method in class UserList

Get mode

UserTags::getMode() — Method in class UserTags

Get mode

UserTags::getListMode() — Method in class UserTags

Get list mode

VuFind::getChangeTracker() — Method in class VuFind

Get the change tracker table object.

VuFind::getConfig() — Method in class VuFind

Get a configuration file.

VuFind::getFirstIndexed() — Method in class VuFind

Get the date/time of the first time this record was indexed.

VuFind::getLastIndexed() — Method in class VuFind

Get the date/time of the most recent time this record was indexed.

VuFind::getParser() — Method in class VuFind

Read parser method from fulltext.ini

VuFind::getApertureCommand() — Method in class VuFind

Generic method for building Aperture Command

VuFind::getTikaCommand() — Method in class VuFind

Generic method for building Tika command

VuFindGeo::getAllCoordinatesFromCoverage() — Method in class VuFindGeo

Format valid coordinates for indexing into Solr; return empty string if coordinates are invalid.

VuFindGeo::getDisplayCoordinatesFromCoverage() — Method in class VuFindGeo

Format valid coordinates for user display; return empty string if coordinates are invalid.

VuFindGeo::getLabelFromCoverage() — Method in class VuFindGeo

Extract a label from a dc:coverage string.

VuFindSitemap::getApertureFields() — Method in class VuFindSitemap

Load metadata about an HTML document using Aperture.

VuFindSitemap::getTikaFields() — Method in class VuFindSitemap

Load metadata about an HTML document using Tika.

VuFindSitemap::getHtmlFields() — Method in class VuFindSitemap

Extract key metadata from HTML.

VuFindSitemap::getDocument() — Method in class VuFindSitemap

Harvest the contents of a document file (PDF, Word, etc.) using Aperture.

VuFindSitemap::getDocumentFieldArray() — Method in class VuFindSitemap

Support method for getDocument() -- retrieve associative array of field data.

VuFindWorkKeys::getWorkKeys() — Method in class VuFindWorkKeys

Get all work identification keys for the record.

Importer::generateXML() — Method in class Importer

Transform $xmlFile using the provided $properties configuration.

H

$ XCNCIP2Test#holdingTestsProperty in class XCNCIP2Test
$ XCNCIP2Test#holdsTestsProperty in class XCNCIP2Test

Test definition for testGetMyHolds

Edd::handleRequest() — Method in class Edd

Handle a request.

GetACSuggestions::handleRequest() — Method in class GetACSuggestions

Handle a request.

GetCitations::handleRequest() — Method in class GetCitations

Handle a request.

$ GetHolding#holdsProperty in class GetHolding

Holds logic

$ GetHolding#holdingsLogicProperty in class GetHolding

Holdings logic helper

GetHolding::handleRequest() — Method in class GetHolding

Handle a request.

GetLibrariesACSuggestions::handleRequest() — Method in class GetLibrariesACSuggestions

Handle a request.

GetObalkyKnihCoverWithoutSolr::handleRequest() — Method in class GetObalkyKnihCoverWithoutSolr

Handle request

GetUserProfile::handleRequest() — Method in class GetUserProfile

Handle a request.

GetZiskejEddFee::handleRequest() — Method in class GetZiskejEddFee

Handle request

HarvestWidgetsContentsClass in namespace KnihovnyCz\AjaxHandler

Class HarvestWidgetsContents

HarvestWidgetsContents::handleRequest() — Method in class HarvestWidgetsContents

Handle a request.

HarvestWidgetsContentsFactoryClass in namespace KnihovnyCz\AjaxHandler

Class HarvestWidgetsContentsFactory

SaveInstitutionFilter::handleRequest() — Method in class SaveInstitutionFilter

Handle a request.

$ Sfx#httpServiceProperty in class Sfx
Configuration
Sfx::handleRequest() — Method in class Sfx

Handle a request.

HighlighterClass in namespace KnihovnyCz\Autocomplete

Class Highlighter

Highlighter::highlight() — Method in class Highlighter

Highlight the result

HoldsControllerClass in namespace KnihovnyCz\Controller

Class HoldsController

InspirationController::homeAction() — Method in class InspirationController

Home action

InspirationController::homeLegacyAction() — Method in class InspirationController

Show action

LibraryCardsController::homeAction() — Method in class LibraryCardsController

Send user's library cards to the view

MyResearchController::historicloansAction() — Method in class MyResearchController

Send list of historic loans to view

MyResearchController::historicloansAjaxAction() — Method in class MyResearchController

Send list of historic loans to view

MyResearchZiskejEddController::homeAction() — Method in class MyResearchZiskejEddController

Ziskej tickets page

MyResearchZiskejMvsController::homeAction() — Method in class MyResearchZiskejMvsController

Ziskej tickets page

HoldsClass in namespace KnihovnyCz\Controller\Plugin

Action helper to perform holds-related actions

RecordController::holdAction() — Method in class RecordController

Action for dealing with holds.

SearchController::homeAction() — Method in class SearchController

Home action

ZiskejAdminController::homeAction() — Method in class ZiskejAdminController

Home action

$ User#home_libraryProperty in class User
$ UserCard#home_libraryProperty in class UserCard
AskLibrary::handle() — Method in class AskLibrary

Get data from submitted form and process them.

KohaRest1905::holdError() — Method in class KohaRest1905

Return a hold error message

$ XCNCIP2#holdRequestTypesProperty in class XCNCIP2

Lowercased request type strings identifying holds

HoldingsClass in namespace KnihovnyCz\ILS\Logic

Class Holdings

HoldsClass in namespace KnihovnyCz\ILS\Logic

Class Holds

BuyLinksTrait::hasBuyLinks() — Method in class BuyLinksTrait

Check whether is there any buy link

SolrAuthority::hasPublications() — Method in class SolrAuthority

Returns true, if authority has publications.

SolrAuthority::hasPublicationsAbout() — Method in class SolrAuthority

Returns true, if there are publications about this authority.

SolrDefault::hasLinks() — Method in class SolrDefault

Does record have some links to show?

SolrDefault::has856Links() — Method in class SolrDefault

Does record has links from marc field 856

SolrDefault::hasDeduplicatedRecords() — Method in class SolrDefault

Return true if the record is one of the duplicate records in group

SolrLibrary::hasAdditionalInfo() — Method in class SolrLibrary

Does library has any additional data? (sigla or last update date)

SolrLibrary::hasContacts() — Method in class SolrLibrary

Does library has any contact defined?

SolrLibrary::hasServices() — Method in class SolrLibrary

Does library has any provided service defined?

SolrLibrary::hasBranches() — Method in class SolrLibrary

Does library has a branch?

SolrLocal::hasOfflineHoldings() — Method in class SolrLocal

Does record has any items attached?

HoldingsILSClass in namespace KnihovnyCz\RecordTab

Class HoldingILS

DeduplicationHelper::hasChildFilter() — Method in class DeduplicationHelper

Check search parameters for child records filter

$ JsonFacetListener#hiddenFiltersProperty in class JsonFacetListener

Hidden filters to apply

HttpServiceClass in namespace KnihovnyCz\Service

Knihovny.cz HttpService

HttpServiceFactoryClass in namespace KnihovnyCz\Service

KnihovnyCz HTTP Service factory.

$ SparqlService#httpServiceProperty in class SparqlService

Http service

AdminController::homeAction() — Method in class AdminController

Admin home.

ConfigController::homeAction() — Method in class ConfigController

Configuration management

FeedbackController::homeAction() — Method in class FeedbackController

Home action

MaintenanceController::homeAction() — Method in class MaintenanceController

System Maintenance

OverdriveController::homeAction() — Method in class OverdriveController

Tag Details

SocialstatsController::homeAction() — Method in class SocialstatsController

Social statistics reporting

TagsController::homeAction() — Method in class TagsController

Tag Details

$ RecordFormatter#helperManagerProperty in class RecordFormatter

View helper plugin manager

HarvestOaiCommandClass in namespace VuFindConsole\Command\Harvest

Console command: VuFind-specific customizations to OAI-PMH harvest command

HarvestOaiCommandFactoryClass in namespace VuFindConsole\Command\Harvest

Factory for OAI harvest command.

WebCrawlCommand::harvestSitemap() — Method in class WebCrawlCommand

Process a sitemap URL, either harvesting its contents directly or recursively reading in child sitemaps.

$ InstallCommand#hostProperty in class InstallCommand

Hostname of VuFind installation (used for host-based multi-site).

$ NotifyCommand#hmacProperty in class NotifyCommand

HMAC generator

DevtoolsController::homeAction() — Method in class DevtoolsController

Home action

Base::httpRequest() — Method in class Base

Perform an HTTP request.

Connector::httpRequest() — Method in class Connector

Perform an HTTP request.

$ SearchRequestModel#highlightProperty in class SearchRequestModel

Whether or not to highlight the search term in the results.

BackendException::hasTag() — Method in class BackendException

Return true if the exception has the requested tag.

HttpErrorExceptionClass in namespace VuFindSearch\Backend\Exception

HTTP error exception.

$ Connector#hostProperty in class Connector

Base URL for API

$ Connector#hostProperty in class Connector

Base URL for API

$ Connector#highlightRegExProperty in class Connector

Regular expression to match highlighted terms

$ Connector#hostProperty in class Connector

The host to connect to

$ WriteDocumentCommand#handlerProperty in class WriteDocumentCommand

Handler to use.

HandlerMapClass in namespace VuFindSearch\Backend\Solr

SOLR backend handler map.

$ HandlerMap#handlersProperty in class HandlerMap

Search handlers, indexed by function.

LuceneSyntaxHelper::hasCaseSensitiveBooleans() — Method in class LuceneSyntaxHelper

Are there any case-sensitive Boolean operators configured?

LuceneSyntaxHelper::hasCaseSensitiveRanges() — Method in class LuceneSyntaxHelper

Are case-sensitive ranges configured?

QueryBuilder::hasDismaxParamsField() — Method in class QueryBuilder

Check if any of the given search types has the field in DismaxParams

Terms::hasFieldTerms() — Method in class Terms

Does the requested field exist?

SearchHandler::hasDismax() — Method in class SearchHandler

Return true if the handler defines Dismax fields.

SearchHandler::hasExtendedDismax() — Method in class SearchHandler

Return true if the handler supports Extended Dismax.

SearchHandler::hasFilterQuery() — Method in class SearchHandler

Return true if handler defines a filter query.

$ SimilarBuilder#handlerParamsProperty in class SimilarBuilder

MoreLikeThis Handler parameters

ParamBag::hasParam() — Method in class ParamBag

Return true if the bag contains any value(s) for the specified parameter.

AbstractRecordCollection::has() — Method in class AbstractRecordCollection

Check if the collection contains the given record

HandlerMapTestClass in namespace VuFindTest\Backend\Solr

Unit tests for SOLR HandlerMap.

HarvestOaiCommandTestClass in namespace VuFindTest\Command\Harvest

HarvestOai command test.

MockContainerTrait::has() — Method in class MockContainerTrait

Returns true if the container can return an entry for the given identifier.

HoldsTestClass in namespace VuFindTest\Controller\Plugin

Class HoldsTest

HMACTestClass in namespace VuFindTest\Crypt

HMAC Test Class

HttpDownloadExceptionTestClass in namespace VuFindTest\Exception

HttpDownloadException Test Class

$ LiveDatabaseTrait#hasLiveDatabaseTraitProperty in class LiveDatabaseTrait

Flag to allow other traits to test for the presence of this one (to enforce dependencies).

$ LiveDetectionTrait#hasLiveDetectionTraitProperty in class LiveDetectionTrait

Flag to allow other traits to test for the presence of this one (to enforce dependencies).

HorizonTestClass in namespace VuFindTest\ILS\Driver

ILS driver test

HorizonXMLAPITestClass in namespace VuFindTest\ILS\Driver

ILS driver test

$ PAIATest#holdsTestResultProperty in class PAIATest
$ XCNCIP2Test#holdsTestsProperty in class XCNCIP2Test

Test definition for testGetMyHolds

$ XCNCIP2Test#holdingTestsProperty in class XCNCIP2Test

Test definition for testGetHolding

MinkTestCase::hasElementsMatchingText() — Method in class MinkTestCase

Check whether an element containing the specified text exists.

HighwirePressTestClass in namespace VuFindTest\MetadataVocabulary

HighwirePress Test Class

HoldsTestClass in namespace VuFindTest\Mink

Test class for holds-related functionality.

HomePageFacetsTestClass in namespace VuFindTest\Mink

Test functionality of the home page facets.

HoldingsILSTestClass in namespace VuFindTest\RecordTab

HoldingsILS Test Class

HoldingsWorldCatTestClass in namespace VuFindTest\RecordTab

HoldingsWorldCat Test Class

HideFacetValueListenerTestClass in namespace VuFindTest\Search\Base

Unit tests for Hide Facet Value Listener.

HistoryTestClass in namespace VuFindTest\Search

History unit tests.

PrimoPermissionHandlerTest::handlerMemberAuthNotSuccessfullCallback() — Method in class PrimoPermissionHandlerTest

Helper function (Callback) to inject different return values for the mock object with different parameters

PrimoPermissionHandlerTest::handlerMemberAuthSuccessfullCallback() — Method in class PrimoPermissionHandlerTest

Helper function (Callback) to inject different return values for the mock object with different parameters

PrimoPermissionHandlerTest::handlerDefaultAuthSuccessfullCallback() — Method in class PrimoPermissionHandlerTest

Helper function (Callback) to inject different return values for the mock object with different parameters

PrimoPermissionHandlerTest::handlerDefaultAuthNotSuccessfullCallback() — Method in class PrimoPermissionHandlerTest

Helper function (Callback) to inject different return values for the mock object with different parameters

PrimoPermissionHandlerTest::handlerMemberIsOnCampusCallback() — Method in class PrimoPermissionHandlerTest

Helper function (Callback) to inject different return values for the mock object with different parameters

PrimoPermissionHandlerTest::handlerMemberIsNotOnCampusCallback() — Method in class PrimoPermissionHandlerTest

Helper function (Callback) to inject different return values for the mock object with different parameters

PrimoPermissionHandlerTest::handlerIsNotAMemberCallback() — Method in class PrimoPermissionHandlerTest

Helper function (Callback) to inject different return values for the mock object with different parameters

PrimoPermissionHandlerTest::handlerIsOnDefaultCampusCallback() — Method in class PrimoPermissionHandlerTest

Helper function (Callback) to inject different return values for the mock object with different parameters

HierarchicalFacetHelperTestClass in namespace VuFindTest\Search\Solr

Unit tests for Hierarchical Facet Helper.

$ HierarchicalFacetHelperTest#helperProperty in class HierarchicalFacetHelperTest

Hierarchical Facet Helper

HelpTextTestClass in namespace VuFindTest\View\Helper\Root

HelpText View Helper Test Class

HoldingsTestClass in namespace VuFindTest\View\Helper\Root

Holdings view helper Test Class

MakeTagTest::htmlAttributesTests() — Method in class MakeTagTest

Test that responds to common inputs

MakeTagTest::helperOptionTests() — Method in class MakeTagTest
HeadLinkClass in namespace VuFindTheme\View\Helper

Head link view helper (extended for VuFind's theme system)

HeadScriptClass in namespace VuFindTheme\View\Helper

Head script view helper (extended for VuFind's theme system)

AbstractUserRequestAction::handleRequest() — Method in class AbstractUserRequestAction

Handle a request.

AjaxHandlerInterface::handleRequest() — Method in class AjaxHandlerInterface

Handle a request.

CheckRequestIsValid::handleRequest() — Method in class CheckRequestIsValid

Handle a request.

CommentRecord::handleRequest() — Method in class CommentRecord

Handle a request.

DeleteRecordComment::handleRequest() — Method in class DeleteRecordComment

Handle a request.

DoiLookup::handleRequest() — Method in class DoiLookup

Handle a request.

GetACSuggestions::handleRequest() — Method in class GetACSuggestions

Handle a request.

GetFacetData::handleRequest() — Method in class GetFacetData

Handle a request.

GetIlsStatus::handleRequest() — Method in class GetIlsStatus

Handle a request.

$ GetItemStatuses#holdLogicProperty in class GetItemStatuses

Holds logic

GetItemStatuses::handleRequest() — Method in class GetItemStatuses

Handle a request.

GetLibraryPickupLocations::handleRequest() — Method in class GetLibraryPickupLocations

Handle a request.

GetRecordCommentsAsHTML::handleRequest() — Method in class GetRecordCommentsAsHTML

Handle a request.

GetRecordCover::handleRequest() — Method in class GetRecordCover

Handle request

GetRecordDetails::handleRequest() — Method in class GetRecordDetails

Handle a request.

GetRecordRating::handleRequest() — Method in class GetRecordRating

Handle a request.

GetRecordTags::handleRequest() — Method in class GetRecordTags

Handle a request.

GetRecordVersions::handleRequest() — Method in class GetRecordVersions

Handle a request.

GetRequestGroupPickupLocations::handleRequest() — Method in class GetRequestGroupPickupLocations

Handle a request.

GetResolverLinks::handleRequest() — Method in class GetResolverLinks

Handle a request.

GetResultCount::handleRequest() — Method in class GetResultCount

Handle a request.

GetSaveStatuses::handleRequest() — Method in class GetSaveStatuses

Handle a request.

GetSideFacets::handleRequest() — Method in class GetSideFacets

Handle a request.

GetUserFines::handleRequest() — Method in class GetUserFines

Handle a request.

GetUserTransactions::handleRequest() — Method in class GetUserTransactions

Handle a request.

GetVisData::handleRequest() — Method in class GetVisData

Handle a request.

KeepAlive::handleRequest() — Method in class KeepAlive

Handle a request.

Recommend::handleRequest() — Method in class Recommend

Handle a request.

RelaisAvailability::handleRequest() — Method in class RelaisAvailability

Handle a request.

RelaisInfo::handleRequest() — Method in class RelaisInfo

Handle a request.

RelaisOrder::handleRequest() — Method in class RelaisOrder

Handle a request.

SystemStatus::handleRequest() — Method in class SystemStatus

Handle a request.

TagRecord::handleRequest() — Method in class TagRecord

Handle a request.

ChoiceAuth::hasLegalStrategy() — Method in class ChoiceAuth

Is the configured strategy on the list of legal options?

ILS::handleLogin() — Method in class ILS

Handle the actual login with the ILS.

$ Solr#handlerProperty in class Solr

Autocomplete handler

Manager::hasDirectoryCreationError() — Method in class Manager

Check if there have been problems creating directories.

Oracle::handleError() — Method in class Oracle

Store information about an error.

AbstractBase::holds() — Method in class AbstractBase

Holds plugin

AbstractRecord::homeAction() — Method in class AbstractRecord

Home (default) action -- forward to requested (or default) tab.

AbstractSearch::homeAction() — Method in class AbstractSearch

Home action

$ AlmaController#httpServiceProperty in class AlmaController

Http service

$ AlmaController#httpResponseProperty in class AlmaController

Http response

$ AlmaController#httpHeadersProperty in class AlmaController

Http headers

AlphabrowseController::homeAction() — Method in class AlphabrowseController

Gathers data for the view of the AlphaBrowser and does some initialization

AuthorController::homeAction() — Method in class AuthorController

Displays the proper page for a search action

AuthorityController::homeAction() — Method in class AuthorityController

Home action

AuthorityRecordController::homeAction() — Method in class AuthorityRecordController

Home (default) action -- forward to requested (or default) tab.

BrowseController::homeAction() — Method in class BrowseController

Gathers data for the view of the AlphaBrowser and does some initialization

CartController::homeAction() — Method in class CartController

Display cart contents.

ChannelsController::homeAction() — Method in class ChannelsController

Generates static front page of channels.

CollectionsController::homeAction() — Method in class CollectionsController

Browse action

CombinedController::homeAction() — Method in class CombinedController

Home action

FeedbackController::homeAction() — Method in class FeedbackController

Display Feedback home form.

HelpControllerClass in namespace VuFind\Controller

Home action for Help module

HelpController::homeAction() — Method in class HelpController

Uses the user language to determine which Help template to use Uses the English template as a back-up

HierarchyControllerClass in namespace VuFind\Controller

Hierarchy Controller

HoldsControllerClass in namespace VuFind\Controller

Controller for the user holds area.

HoldsControllerFactoryClass in namespace VuFind\Controller

Holds controller factory.

HoldsTraitClass in namespace VuFind\Controller

Holds trait (for subclasses of AbstractRecord)

HoldsTrait::holdAction() — Method in class HoldsTrait

Action for dealing with holds.

IndexController::homeAction() — Method in class IndexController

Determines what elements are displayed on the home page based on whether the user is logged in.

InstallController::homeAction() — Method in class InstallController

Display summary of installation status

LibraryCardsController::homeAction() — Method in class LibraryCardsController

Send user's library cards to the view

MissingrecordController::homeAction() — Method in class MissingrecordController

Display simple message.

MyResearchController::homeAction() — Method in class MyResearchController

Prepare and direct the home page where it needs to go

MyResearchController::holdsAction() — Method in class MyResearchController

Send list of holds to view

MyResearchController::historicloansAction() — Method in class MyResearchController

Send list of historic loans to view

OAuth2Controller::handleException() — Method in class OAuth2Controller

Create a server error response.

OaiController::homeAction() — Method in class OaiController

Display OAI server form.

OaiController::handleOAI() — Method in class OaiController

Shared OAI logic.

OverdriveController::holdAction() — Method in class OverdriveController

Hold Action

$ AbstractRequestBase#hmacProperty in class AbstractRequestBase

HMAC generator

HoldsClass in namespace VuFind\Controller\Plugin

Action helper to perform holds-related actions

RecordsController::homeAction() — Method in class RecordsController

Home action -- call standard results action

SearchController::historyAction() — Method in class SearchController

Handle search history display && purge

TagController::homeAction() — Method in class TagController

Home action

UpgradeController::hasDatabaseRootCredentials() — Method in class UpgradeController

Do we have root DB credentials stored?

UpgradeController::homeAction() — Method in class UpgradeController

Display summary of installation status

$ CookieManager#httpOnlyProperty in class CookieManager

Are cookies HTTP only?

CachingProxy::hasLegalHost() — Method in class CachingProxy

Check if the URL is on the configured list for caching.

$ Loader#httpServiceProperty in class Loader

HTTP client factory

$ Loader#hasLoadedUnavailableProperty in class Loader

Flag denoting the last loaded image was a FailImage

Loader::hasLoadedUnavailable() — Method in class Loader

Returns true if the last loaded image was the FailImage

HMACClass in namespace VuFind\Crypt

HMAC hash generator wrapper

$ HMAC#hashKeyProperty in class HMAC

Hash key

HMACFactoryClass in namespace VuFind\Crypt

Plugin Manager factory.

$ User#home_libraryProperty in class User
$ UserCard#home_libraryProperty in class UserCard
HttpDownloadExceptionClass in namespace VuFind\Exception

"Format Unavailable" Exception

HttpStatusInterfaceClass in namespace VuFind\Exception

Interface for exceptions that should trigger specific HTTP status codes when unhandled.

$ Form#handlerManagerProperty in class Form

Handler plugin manager

Database::handle() — Method in class Database

Get data from submitted form and process them.

Email::handle() — Method in class Email

Get data from submitted form and process them.

HandlerInterfaceClass in namespace VuFind\Form\Handler

Interface HandlerInterface

HandlerInterface::handle() — Method in class HandlerInterface

Get data from submitted form and process them.

$ AbstractBase#hierarchyDriverProperty in class AbstractBase

Hierarchy driver

HasSorterInterfaceClass in namespace VuFind\I18n

Interface SortingInterface

HasSorterTraitClass in namespace VuFind\I18n

Trait SortingTrait

$ Connection#holdsModeProperty in class Connection

Holds mode

Connection::hasNoILSFailover() — Method in class Connection

Are we configured to fail over to the NoILS driver on error?

Connection::hasHoldings() — Method in class Connection

Has Holdings

$ Aleph#hostProperty in class Aleph

Aleph server

HorizonClass in namespace VuFind\ILS\Driver

Horizon ILS Driver

HorizonXMLAPIClass in namespace VuFind\ILS\Driver

Horizon ILS Driver (w/ XML API support)

$ KohaILSDI#hostProperty in class KohaILSDI

Web services host

KohaRest::holdError() — Method in class KohaRest

Return a hold error message

NoILS::hasHoldings() — Method in class NoILS

Has Holdings

$ SierraRest#holdAvailableCodesProperty in class SierraRest

Status codes indicating that a hold is available for pickup

$ SierraRest#holdInTransitCodesProperty in class SierraRest

Status codes indicating that a hold is in transit

SierraRest::holdError() — Method in class SierraRest

Hold Error

$ Unicorn#hostProperty in class Unicorn
Host
Virtua::httpRequest() — Method in class Virtua

Support method -- perform an HTTP request. This will be a GET request unless either $postParams or $rawPost is set to a non-null value.

$ VoyagerRestful#holdCheckLimitProperty in class VoyagerRestful

The maximum number of holds to check at a time (0 = no limit)

$ VoyagerRestful#holdsModeProperty in class VoyagerRestful

Holds mode

VoyagerRestful::holdError() — Method in class VoyagerRestful

Hold Error

$ XCNCIP2#holdRequestTypesProperty in class XCNCIP2

Lowercased request type strings identifying holds

$ XCNCIP2#holdProblemsDisplayProperty in class XCNCIP2

Which subelements of Problem element show to user when placing hold fails.

XCNCIP2::handleCancelRequest() — Method in class XCNCIP2

General cancel request method

HoldSettingsClass in namespace VuFind\ILS

ILS Hold Settings Class

HoldSettingsFactoryClass in namespace VuFind\ILS

ILS hold settings factory

HoldsClass in namespace VuFind\ILS\Logic

Hold Logic Class

$ Holds#hmacProperty in class Holds

HMAC generator

$ Holds#hideHoldingsProperty in class Holds

Holding locations to hide from display

$ TitleHolds#hmacProperty in class TitleHolds

HMAC generator

$ TitleHolds#hideHoldingsProperty in class TitleHolds

Holding locations to hide from display

LoggerFactory::hasDynamicDebug() — Method in class LoggerFactory

Is dynamic debug mode enabled?

HighwirePressClass in namespace VuFind\MetadataVocabulary

Metadata vocabulary implementation for Highwire Press

Server::hasParam() — Method in class Server

Was the specified parameter provided?

$ ScopeEntity#hiddenProperty in class ScopeEntity

Whether the scope is hidden from the scope list

$ AuthorityRecommend#headerProperty in class AuthorityRecommend

Header to use in the user interface.

$ MapSelection#heightProperty in class MapSelection

Height of search map pane

RemoveFilters::hasFilters() — Method in class RemoveFilters

Determines if filters are applied or not.

$ SideFacets#hierarchicalFacetsProperty in class SideFacets

Hierarchical facet setting

$ SideFacets#hierarchicalFacetSortOptionsProperty in class SideFacets

Hierarchical facet sort options

$ SideFacets#hierarchicalFacetHelperProperty in class SideFacets

Hierarchical facet helper

$ DefaultRecord#highlightProperty in class DefaultRecord

Should we highlight fields in search results?

EDS::hasHTMLFullTextAvailable() — Method in class EDS

Get the full text availability of the record.

EDS::hasEbookAvailable() — Method in class EDS

Get the ebook availability of the record.

EDS::hasPdfAvailable() — Method in class EDS

Get the PDF availability of the record.

EDS::hasEpubAvailable() — Method in class EDS

Get the ePub availability of the record.

EDS::hasLinkedFullTextAvailable() — Method in class EDS

Get the linked full text availability of the record.

HierarchyAwareTraitClass in namespace VuFind\RecordDriver\Feature

Hierarchy support for record drivers.

$ HierarchyAwareTrait#hierarchyDriverManagerProperty in class HierarchyAwareTrait

Hierarchy driver plugin manager

$ HierarchyAwareTrait#hierarchyDriverProperty in class HierarchyAwareTrait

Hierarchy driver for current object

$ IlsAwareTrait#holdLogicProperty in class IlsAwareTrait

Hold logic

IlsAwareTrait::hasILS() — Method in class IlsAwareTrait

Do we have an attached ILS connection?

$ SolrDefault#highlightDetailsProperty in class SolrDefault

Highlighting details

Summon::hasFullText() — Method in class Summon

Does this record have full text access?

$ AbstractContent#hideIfEmptyProperty in class AbstractContent

Should we hide the tab if no content is found?

HierarchyTreeClass in namespace VuFind\RecordTab

HierarchyTree tab

HierarchyTreeFactoryClass in namespace VuFind\RecordTab

Factory for building the HierarchyTree tab.

HoldingsILSClass in namespace VuFind\RecordTab

Holdings (ILS) tab

$ HoldingsILS#hideWhenEmptyProperty in class HoldingsILS

Whether the holdings tab should be hidden when empty or not.

HoldingsILSFactoryClass in namespace VuFind\RecordTab

Factory for building the HoldingsILS tab.

HoldingsWorldCatClass in namespace VuFind\RecordTab

Holdings (WorldCat) tab

HoldingsWorldCatFactoryClass in namespace VuFind\RecordTab

Factory for building the HoldingsWorldCat tab.

Checklist::hasChecked() — Method in class Checklist

Are there checked items?

Checklist::hasUnchecked() — Method in class Checklist

Are there unchecked items?

$ Alma#httpClientProperty in class Alma

HTTP client

$ Jop#httpClientProperty in class Jop

HTTP client

$ Redi#httpClientProperty in class Redi

HTTP client

$ Sfx#httpClientProperty in class Sfx

HTTP client

$ Threesixtylink#httpClientProperty in class Threesixtylink

HTTP client

BackendManager::has() — Method in class BackendManager

Return true if named backend is available.

HideFacetValueListenerClass in namespace VuFind\Search\Base

Hide single facet values from displaying.

$ HideFacetValueListener#hideFacetsProperty in class HideFacetValueListener

List of facet values to hide, indexed by facet field.

HierarchicalFacetHelperInterfaceClass in namespace VuFind\Search\Base

Hierarchical facet helper interface

$ Options#hierarchicalFacetsProperty in class Options

Hierarchical facets

$ Options#hierarchicalFacetSeparatorsProperty in class Options

Hierarchical facet separators

$ Options#highlightProperty in class Options

Highlighting setting

Options::highlightEnabled() — Method in class Options

Is highlighting enabled?

$ Params#hiddenFiltersProperty in class Params

Pre-assigned filters

Params::hasFilter() — Method in class Params

Does the object already contain the specified filter?

Params::hasHiddenFilter() — Method in class Params

Does the object already contain the specified hidden filter?

Params::hasDefaultsApplied() — Method in class Params

Are default filters applied?

$ Results#helpersProperty in class Results

Helper objects

$ Results#hierarchicalFacetHelperProperty in class Results

Hierarchical facet helper

$ UrlQueryHelperFactory#helperClassProperty in class UrlQueryHelperFactory

Name of class built by factory.

HistoryClass in namespace VuFind\Search

VuFind Search History Helper

HistoryFactoryClass in namespace VuFind\Search

Search history factory.

$ Minified#hfProperty in class Minified

Hidden Filters

$ FacetLimitTrait#hierarchicalFacetLimitProperty in class FacetLimitTrait

Hierarchical facet limit when facets are requested.

PrimoPermissionHandler::hasPermission() — Method in class PrimoPermissionHandler

Check if the user has permission

DeduplicationListener::hasChildFilter() — Method in class DeduplicationListener

Check search parameters for child records filter

HierarchicalFacetHelperClass in namespace VuFind\Search\Solr

Functions for manipulating facets

HierarchicalFacetHelperFactoryClass in namespace VuFind\Search\Solr

Class HierarchicalFacetHelperFactory

HierarchicalFacetListenerClass in namespace VuFind\Search\Solr

Solr hierarchical facet handling listener.

LowerCaseServiceNameTrait::has() — Method in class LowerCaseServiceNameTrait

Returns true if the container can return an entry for the given identifier.

HttpServiceFactoryClass in namespace VuFind\Service

VuFind HTTP Service factory.

HandlerInterfaceClass in namespace VuFind\Session

Session handler interface

$ SecureDelegator#handlerProperty in class SecureDelegator

The wrapped session handler.

$ Database#hashAlgorithmProperty in class Database

Hash algorithm to use

HighlightClass in namespace VuFind\View\Helper\Bootstrap3

Highlight view helper

$ AccountCapabilities#helperProperty in class AccountCapabilities

Capabilities helper

Captcha::html() — Method in class Captcha

Generate HTML depending on CAPTCHA type (empty if not active).

$ CookieConsent#hostNameProperty in class CookieConsent

Server name

HeadTitleFactoryClass in namespace VuFind\View\Helper\Root

HeadTitle helper factory.

HelpTextClass in namespace VuFind\View\Helper\Root

"Load help text" view helper

HelpTextFactoryClass in namespace VuFind\View\Helper\Root

HelpText helper factory.

HighlightClass in namespace VuFind\View\Helper\Root

Highlight view helper

HistoryLabelClass in namespace VuFind\View\Helper\Root

"Search history label" view helper

HistoryLabelFactoryClass in namespace VuFind\View\Helper\Root

HistoryLabel helper factory.

HoldingsClass in namespace VuFind\View\Helper\Root

View helper to support ILS holdings display

Holdings::holdingIsVisible() — Method in class Holdings

Is the provided holdings array (from an ILS driver's getHolding method) suitable for display to the end user?

HoldingsFactoryClass in namespace VuFind\View\Helper\Root

Holdings helper factory.

OpenUrl::hasNonEmptyValue() — Method in class OpenUrl

Check if an array contains a non-empty value.

Record::hasOpenUrlReplaceSetting() — Method in class Record

Get all the links associated with this record depending on the OpenURL setting replace_other_urls. Returns an array of associative arrays each containing 'desc' and 'url' keys.

$ SearchTabs#helperProperty in class SearchTabs

Search tab helper

VuFind::harvestTextFile() — Method in class VuFind

Harvest the contents of a text file for inclusion in the output.

VuFind::harvestWithParser() — Method in class VuFind

Call parsing method based on parser setting in fulltext.ini

VuFind::harvestWithAperture() — Method in class VuFind

Harvest the contents of a document file (PDF, Word, etc.) using Aperture.

VuFind::harvestWithTika() — Method in class VuFind

Harvest the contents of a document file (PDF, Word, etc.) using Tika.

I

$ Search2ApiController#indexLabelProperty in class Search2ApiController

Descriptive label for the index managed by this controller

$ SearchApiController#itemFormatterProperty in class SearchApiController

Record formatter

$ SearchApiController#itemAccessPermissionProperty in class SearchApiController

Permission required for the item endpoint

$ SearchApiController#itemRouteProperty in class SearchApiController

Item route uri

SearchApiController::itemAction() — Method in class SearchApiController

Item action

ItemFormatterClass in namespace KnihovnyCzApi\Formatter

Class ItemFormatter

ItemFormatterFactoryClass in namespace KnihovnyCzApi\Formatter

Class ItemFormatterFactory

$ XCNCIP2Test#itemStatusTestsProperty in class XCNCIP2Test

Test definition for testGetMyHolds

$ GetHolding#ilsProperty in class GetHolding

ILS connection

Manager::isLoggedIn() — Method in class Manager

Checks whether the user is logged in.

Manager::isValidCsrfHash() — Method in class Manager

Does the provided token match the one generated?

SolrAuthorityEnricher::isUnique() — Method in class SolrAuthorityEnricher

Is the authority name unique?

SolrPrefixHandler::initSearchObject() — Method in class SolrPrefixHandler

Initialize the search object used for finding recommendations.

SolrPrefixSorted::initSearchObject() — Method in class SolrPrefixSorted

Initialize the search object used for finding recommendations.

$ AbstractDbAwaredRecordIds#itemsProperty in class AbstractDbAwaredRecordIds

List items

$ AbstractDbAwaredRecordIds#itemsTableNameProperty in class AbstractDbAwaredRecordIds

Table for list items

$ DocumentTypes#itemsConfigProperty in class DocumentTypes

Content configuration

$ UserList#itemsTableNameProperty in class UserList

Table for list items

InvolvedLibrariesServiceClass in namespace KnihovnyCz\Content

Class InvolvedLibrariesService

InvolvedLibrariesServiceFactoryClass in namespace KnihovnyCz\Content

Class InvolvedLibrariesServiceFactory

InspirationControllerClass in namespace KnihovnyCz\Controller

Class Inspiration

ResultScroller::init() — Method in class ResultScroller

Initialize this result set scroller. This should only be called prior to displaying the results of a new search.

ResultScroller::initLastSearch() — Method in class ResultScroller

Initialize the last saved search. Optimization to prevent restoring last search twice from this and parent class.

PortalPageController::indexAction() — Method in class PortalPageController

Index action - redirects to legacy url

WayfController::indexAction() — Method in class WayfController

Returns text response with encoded fiter for CESNET DS/WAYF service

InstConfigsClass in namespace KnihovnyCz\Db\Row

Class InstConfigs

InstSourcesClass in namespace KnihovnyCz\Db\Row

Class InstSources

$ User#idProperty in class User
User::isSocial() — Method in class User

Return if the user is from social network - has no connected library card with ILS.

$ UserCard#idProperty in class UserCard
$ UserSettings#idProperty in class UserSettings
InstConfigsClass in namespace KnihovnyCz\Db\Table

Class InstConfigs

InstSourcesClass in namespace KnihovnyCz\Db\Table

Class InstSources

KohaRest1905::init() — Method in class KohaRest1905

Initialize the driver.

$ MultiBackend#instConfigsProperty in class MultiBackend

Table gateway to source configuration

$ MultiBackend#instSourcesProperty in class MultiBackend

Table gateway to institution source

$ MultiBackend#idResolverProperty in class MultiBackend

Id resolver

MultiBackend::isExpired() — Method in class MultiBackend

Return if the date is in the past, used for checking expired checked out items or registrations.

XCNCIP2::init() — Method in class XCNCIP2

Initialize the driver.

XCNCIP2::isNextItemTokenEmpty() — Method in class XCNCIP2

Check NextItemToken for emptiness

InvolvedLibrariesBuilderClass in namespace KnihovnyCz\Markdown\InvolvedLibraries

Class InvolvedLibrariesBuilder

InvolvedLibrariesExtensionClass in namespace KnihovnyCz\Markdown\InvolvedLibraries

Class InvolvedLibrariesExtension

$ InvolvedLibrariesExtension#involvedLibrariesServiceProperty in class InvolvedLibrariesExtension

Involved libraries service

InvolvedLibrariesExtensionFactoryClass in namespace KnihovnyCz\Markdown\InvolvedLibraries

Class InvolvedLibrariesExtensionFactory

InvolvedLibrariesParserClass in namespace KnihovnyCz\Markdown\InvolvedLibraries

Class InvolvedLibrariesParser

InvolvedLibrariesRendererClass in namespace KnihovnyCz\Markdown\InvolvedLibraries

Class InvolvedLibrariesRenderer

$ InvolvedLibrariesRenderer#innerRendererProperty in class InvolvedLibrariesRenderer

Main node renderer

InvolvedLibrariesClass in namespace KnihovnyCz\Markdown\InvolvedLibraries\Node

Class InvolvedLibraries

InvolvedLibrariesPlaceholderClass in namespace KnihovnyCz\Markdown\InvolvedLibraries\Node

Class InvolvedLibrariesPlaceholder

Module::init() — Method in class Module

Initialize the module

MapSelection::isActive() — Method in class MapSelection

Enable recommendations?

MapSelection::init() — Method in class MapSelection

Called at the end of the Search Params objects' initFromRequest() method.

RecommendOtherPortals::init() — Method in class RecommendOtherPortals

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

$ SideFacetsDeferred#institutionFieldProperty in class SideFacetsDeferred

Solr institution field

$ SolrAuthority#identifiersProperty in class SolrAuthority
SolrDefault::isTypePeriodical() — Method in class SolrDefault

Return if Periodical type

SolrDefault::isTypeBook() — Method in class SolrDefault

Return if Book type

$ SolrLibrary#institutionFieldProperty in class SolrLibrary

Institution field

SolrMarc::isAleph() — Method in class SolrMarc

Is record from library with Aleph ILS?

SolrMarc::isArl() — Method in class SolrMarc

Is record from library with ARL ILS?

SolrMarc::isVerbis() — Method in class SolrMarc

Is record from library with Verbis ILS?

Buy::isActive() — Method in class Buy

Is this tab visible?

Cites::isActive() — Method in class Cites

Is this tab visible?

DedupedRecords::isActive() — Method in class DedupedRecords

Is this tab visible?

EVersion::isActive() — Method in class EVersion

Is this tab visible?

HoldingsILS::isActive() — Method in class HoldingsILS

Is this tab initially visible?

LibraryBranches::isActive() — Method in class LibraryBranches

Is this tab visible?

LibraryContacts::isActive() — Method in class LibraryContacts

Is this tab visible?

LibraryInfo::isActive() — Method in class LibraryInfo

Is this tab visible?

LibraryServices::isActive() — Method in class LibraryServices

Is this tab visible?

$ ZiskejBase#ilsDriverProperty in class ZiskejBase
$ ZiskejBase#isZiskejActiveProperty in class ZiskejBase
ZiskejBase::isZiskejActive() — Method in class ZiskejBase

Return whether Ziskej is active

ZiskejEdd::isActive() — Method in class ZiskejEdd

Is this tab visible?

ZiskejMvs::isActive() — Method in class ZiskejMvs

Is this tab visible?

Links::init() — Method in class Links

Establishes base settings for making recommendations.

SolrField::init() — Method in class SolrField

Establishes base settings for making recommendations.

ParamBag::isApplyChildFilter() — Method in class ParamBag

Is child filter enabled?

Params::initAdvancedFacets() — Method in class Params

Initialize facet settings for the advanced search screen.

Params::initHomePageFacets() — Method in class Params

Initialize facet settings for the home page.

$ DeduplicationListener#institutionFieldProperty in class DeduplicationListener

Solr institution field

JsonFacetListener::isOrFacet() — Method in class JsonFacetListener

Return if the field is ORed

CitaceProService::isCitationStyleValid() — Method in class CitaceProService

Validates citation style

NullSessionManager::isValid() — Method in class NullSessionManager

Is this session valid?

IndexClass in namespace KnihovnyCz\Sitemap\Plugin

Index-based generator plugin

IndexFactoryClass in namespace KnihovnyCz\Sitemap\Plugin

Index-based generator plugin factory

DatabaseCsrf::isValid() — Method in class DatabaseCsrf

Returns true if and only if token is valid.

GoogleTagManager::isEnabled() — Method in class GoogleTagManager

Is GTM enabled

ZiskejEdd::isEnabled() — Method in class ZiskejEdd

Return if Ziskej is enabled

ZiskejEdd::isProduction() — Method in class ZiskejEdd

Return if Ziskej is in production mode

ZiskejMvs::isEnabled() — Method in class ZiskejMvs

Return if Ziskej is enabled

ZiskejMvs::isProduction() — Method in class ZiskejMvs

Return if Ziskej is in production mode

Ziskej::isEnabled() — Method in class Ziskej

Get if ziskej is enabled on cpk

Ziskej::isMode() — Method in class Ziskej

Check if mode exists

ApiController::indexAction() — Method in class ApiController

Index action

ApiTrait::isAccessDenied() — Method in class ApiTrait

Check whether access is denied and return the appropriate message or false.

$ Search2ApiController#indexLabelProperty in class Search2ApiController

Descriptive label for the index managed by this controller

$ SearchApiController#indexLabelProperty in class SearchApiController

Descriptive label for the index managed by this controller

$ WebApiController#indexLabelProperty in class WebApiController

Descriptive label for the index managed by this controller

ImportCsvCommandClass in namespace VuFindConsole\Command\Import

Console command: CSV importer

$ ImportCsvCommand#importerProperty in class ImportCsvCommand

CSV importer

ImportCsvCommandFactoryClass in namespace VuFindConsole\Command\Import

Factory for CSV import command.

ImportXslCommandClass in namespace VuFindConsole\Command\Import

Console command: XSLT importer

$ ImportXslCommand#importerProperty in class ImportXslCommand

XSLT importer

ImportXslCommandFactoryClass in namespace VuFindConsole\Command\Import

Factory for XSLT import command.

$ WebCrawlCommand#importerProperty in class WebCrawlCommand

XSLT importer

InstallCommandClass in namespace VuFindConsole\Command\Install

Console command: VuFind installer.

InstallCommand::initializeOverrideDir() — Method in class InstallCommand

Initialize the override directory and report success or failure.

$ NotifyCommand#iso8601Property in class NotifyCommand

Useful date format value

IndexReservesCommandClass in namespace VuFindConsole\Command\Util

Console command: index course reserves into Solr.

DevtoolsController::iconAction() — Method in class DevtoolsController

Icon action

Module::init() — Method in class Module

Initialize the module

$ AbstractBackend#identifierProperty in class AbstractBackend

Backend identifier.

AbstractBackend::injectSourceIdentifier() — Method in class AbstractBackend

Inject source identifier in record collection and all contained records.

$ RecordCollection#initialResultsBackendsProperty in class RecordCollection

Backends to be used for initial results

RecordCollection::initBlended() — Method in class RecordCollection

Initialize blended results

$ LookupIssnsCommand#issnsProperty in class LookupIssnsCommand

ISSNs to look up.

ApiException::isApiError() — Method in class ApiException

Is this a know api error

$ Backend#ipAuthProperty in class Backend

Whether or not to use IP Authentication for communication with the EDS API

$ Backend#isGuestProperty in class Backend

Is the current user a guest?

Backend::isGuest() — Method in class Backend

Is the current user a guest? If so, return 'y' else 'n'.

Base::info() — Method in class Base

Obtain edsapi search critera and application related settings

$ SearchRequestModel#includeFacetsProperty in class SearchRequestModel

Whether or not to return facets with the search results. valid values are 'y' or 'n'

SearchRequestModel::isParameterIndexed() — Method in class SearchRequestModel

Determines whether or not a querystring parameter is indexed

$ Connector#iidProperty in class Connector

Institution code

Connector::init() — Method in class Connector

Initializes a session. Returns session ID to be used in subsequent requests.

$ Connector#instProperty in class Connector

Institution code

Backend::injectResponseWriter() — Method in class Backend

Inject response writer and named list implementation into parameters.

Connector::isRethrowableSolrException() — Method in class Connector

Check if an exception from a Solr request should be thrown rather than retried

$ LuceneSyntaxHelper#insideQuotesProperty in class LuceneSyntaxHelper

Lookahead that detects whether or not we are inside quotes.

AbstractBase::isExecuted() — Method in class AbstractBase

Was the command executed?

$ CallMethodCommand#interfaceProperty in class CallMethodCommand

Search backend interface

CommandInterface::isExecuted() — Method in class CommandInterface

Was the command executed?

$ RecordIdentifierTrait#idProperty in class RecordIdentifierTrait

Record identifier.

$ RetrieveBatchCommand#idsProperty in class RetrieveBatchCommand

Record identifiers.

InvalidArgumentExceptionClass in namespace VuFindSearch\Exception

Invalid argument exception.

QueryGroup::isNegated() — Method in class QueryGroup

Return true if group is an exclusion group.

Service::invoke() — Method in class Service

Invoke a command.

ILSAuthenticatorTestClass in namespace VuFindTest\Auth

ILS Authenticator Manager Test Class

ILSTestClass in namespace VuFindTest\Auth

ILS authentication test class.

BackendMock::injectResponseWriter() — Method in class BackendMock

Inject response writer and named list implementation into parameters.

ImporterConfigTestClass in namespace VuFindTest\CSV

CSV Importer Configuration Test Class

ImporterTestClass in namespace VuFindTest\CSV

CSV Importer Test Class

ImageFactoryTestClass in namespace VuFindTest\Captcha

Unit tests for Image CAPTCHA handler factory.

IntervalTestClass in namespace VuFindTest\Captcha

Unit tests for Image CAPTCHA handler factory.

ImportCsvCommandTestClass in namespace VuFindTest\Command\Import

Import/ImportCsv command test.

ImportXslCommandTestClass in namespace VuFindTest\Command\Import

Import/ImportXsl command test.

InstallCommandTestClass in namespace VuFindTest\Command\Import

Install command test.

$ AbstractExpireCommandTest#illegalAgeProperty in class AbstractExpireCommandTest

Age parameter to use when testing illegal age input.

$ ExpireSessionsCommandTest#illegalAgeProperty in class ExpireSessionsCommandTest

Age parameter to use when testing illegal age input.

IndexReservesCommandTestClass in namespace VuFindTest\Command\Util

IndexReservesCommand test.

InstallControllerTestClass in namespace VuFindTest\Controller

Class InstallControllerTest

DummyILS::init() — Method in class DummyILS

Initialize the driver.

ILSMockTraitClass in namespace VuFindTest\ILS\Driver
InnovativeTestClass in namespace VuFindTest\ILS\Driver

ILS driver test

MultiBackendTest::initSimpleMethodTest() — Method in class MultiBackendTest

Initialize a MultiBackend driver for a simple method test with three drivers: Voyager, Demo and Dummy that doesn't handle anything

$ CallnumberBrowseTest#idProperty in class CallnumberBrowseTest

Record ID to use in testing.

IlsActionsTestClass in namespace VuFindTest\Mink

Mink ILS actions test class.

IlsActionsTest::illRequestProcedure() — Method in class IlsActionsTest

Routine to place an ILL request

IpAddressUtilsTestClass in namespace VuFindTest\Net

IpAddressUtils Test Class

IdentityRepositoryTestClass in namespace VuFindTest\OAuth2\Repository

OAuth2 IdentityRepository tests.

SwitchTabTest::inactiveTabConfigProvider() — Method in class SwitchTabTest

Data provider for testGetActiveTab.

ComponentPartsTest::isActiveProvider() — Method in class ComponentPartsTest

Data provider for testIsActive.

FormatsTest::isActiveProvider() — Method in class FormatsTest

Data provider for testIsActive.

HoldingsWorldCatTest::isActiveProvider() — Method in class HoldingsWorldCatTest

Data provider for testIsActive.

PreviewTest::isActiveProvider() — Method in class PreviewTest

Data provider for testIsActive.

TOCTest::isActiveProvider() — Method in class TOCTest

Data provider for testIsActive.

UserCommentsTest::isActiveProvider() — Method in class UserCommentsTest

Data provider for testIsActive.

UserCommentsTest::isCaptchaActiveProvider() — Method in class UserCommentsTest

Data provider for testIsCaptchaActive.

VersionsTest::isActiveProvider() — Method in class VersionsTest

Data provider for testIsActive.

IpRangeTestClass in namespace VuFindTest\Role\PermissionProvider

IpRange ServerParam Test Class

IpRegExTestClass in namespace VuFindTest\Role\PermissionProvider

IpRegEx ServerParam Test Class

$ HierarchicalFacetHelperTest#invalidFacetListProperty in class HierarchicalFacetHelperTest

Invalid test input data.

IndexTestClass in namespace VuFindTest\Sitemap\Plugin

Index Plugin Test Class

$ ThemeCompilerTest#infoProperty in class ThemeCompilerTest

ThemeInfo object for tests

ILSDriverTestCaseClass in namespace VuFindTest\Unit

Abstract base class for ILS driver test cases.

SessionHandlerTestCase::injectMockDatabaseTables() — Method in class SessionHandlerTestCase

Set up mock databases for a session handler.

IconTestClass in namespace VuFindTest\View\Helper\Root

Icon View Helper Test Class

MakeTagTest::invalidTags() — Method in class MakeTagTest
VuFindTest::isInvertedNameProvider() — Method in class VuFindTest

DataProvider for testIsInvertedName().

$ AbstractThemeUtility#infoProperty in class AbstractThemeUtility

Theme info object

InitializerClass in namespace VuFindTheme

VuFind Theme Initializer

Initializer::init() — Method in class Initializer

Initialize the theme. This needs to be triggered as part of the dispatch event.

InjectTemplateListenerClass in namespace VuFindTheme

VuFind "Inject Template" Listener -- this extends the core MVC class to adjust default template configurations to something more appropriate for VuFind.

InjectTemplateListener::inflectName() — Method in class InjectTemplateListener

Inflect a name to a normalized value

InjectTemplateListenerFactoryClass in namespace VuFindTheme

Factory for InjectTemplateListener

ResourceContainer::insertEntry() — Method in class ResourceContainer

Helper function to insert an entry to an array, also considering priority and dependency, if existing.

ConcatTrait::isExcludedFromConcat() — Method in class ConcatTrait

Returns true if file should not be included in the compressed concat file

ConcatTrait::isMinifiable() — Method in class ConcatTrait

Check if a file is minifiable i.e. does not have a pattern that denotes it's already minified

ConcatTrait::isPipelineActive() — Method in class ConcatTrait

Can we use the asset pipeline?

HeadLink::itemToString() — Method in class HeadLink

Create HTML link element from data item

HeadLink::isExcludedFromConcat() — Method in class HeadLink

Returns true if file should not be included in the compressed concat file Required by ConcatTrait

HeadScript::itemToString() — Method in class HeadScript

Create script HTML

HeadScript::isExcludedFromConcat() — Method in class HeadScript

Returns true if file should not be included in the compressed concat file Required by ConcatTrait

ImageLinkClass in namespace VuFindTheme\View\Helper

Image link view helper (extended for VuFind's theme system)

ImageLinkFactoryClass in namespace VuFindTheme\View\Helper

Factory for ImageLink view helper.

InlineScriptClass in namespace VuFindTheme\View\Helper

Inline script view helper (extended for VuFind's theme system)

Slot::isset() — Method in class Slot

Checks for content to provide isset functionality.

$ AbstractIlsAndUserAction#ilsProperty in class AbstractIlsAndUserAction

ILS connection

$ AbstractIlsAndUserAction#ilsAuthenticatorProperty in class AbstractIlsAndUserAction

ILS authenticator

$ GetIlsStatus#ilsProperty in class GetIlsStatus

ILS connection

$ GetItemStatuses#ilsProperty in class GetItemStatuses

ILS connection

AbstractBase::isExpired() — Method in class AbstractBase

Has the user's login expired?

AuthToken::isExpired() — Method in class AuthToken

Is token expired?

CAS::isExpired() — Method in class CAS

Has the user's login expired?

EmailAuthenticator::isValidLoginRequest() — Method in class EmailAuthenticator

Check if the given request is a valid login request

ILSClass in namespace VuFind\Auth

ILS authentication module.

ILSAuthenticatorClass in namespace VuFind\Auth

Class for managing ILS-specific authentication.

$ ILSAuthenticator#ilsAccountProperty in class ILSAuthenticator

Cache for ILS account information (keyed by username)

ILSAuthenticatorFactoryClass in namespace VuFind\Auth

ILS Authenticator factory.

ILSFactoryClass in namespace VuFind\Auth

Factory for ILS authentication module (and others with equivalent constructors).

InvalidArgumentExceptionClass in namespace VuFind\Auth

Invalid Authentication Argument Exception

Manager::isLoggedIn() — Method in class Manager

Checks whether the user is logged in.

Manager::inPrivacyMode() — Method in class Manager

Are we in privacy mode?

Shibboleth::isExpired() — Method in class Shibboleth

Has the user's login expired?

Solr::initSearchObject() — Method in class Solr

Initialize the search object used for finding recommendations.

SolrPrefix::initSearchObject() — Method in class SolrPrefix

Initialize the search object used for finding recommendations.

Bootstrapper::initTestMode() — Method in class Bootstrapper

Set up cookie to flag test mode.

Bootstrapper::initSystemStatus() — Method in class Bootstrapper

If the system is offline, set up a handler to override the routing output.

Bootstrapper::initLocaleAndTimeZone() — Method in class Bootstrapper

Initializes locale and timezone values

Bootstrapper::initContext() — Method in class Bootstrapper

Set view variables representing the current context.

Bootstrapper::initViewModel() — Method in class Bootstrapper

Set up the initial view model.

Bootstrapper::initUserLanguage() — Method in class Bootstrapper

Update language in user account, as needed.

Bootstrapper::initTheme() — Method in class Bootstrapper

Set up theme handling.

Bootstrapper::initExceptionBasedHttpStatuses() — Method in class Bootstrapper

Set up custom HTTP status based on exception information.

Bootstrapper::initSearch() — Method in class Bootstrapper

Set up search subsystem.

Bootstrapper::initErrorLogging() — Method in class Bootstrapper

Set up logging.

Bootstrapper::initRenderErrorEvent() — Method in class Bootstrapper

Set up handling for rendering problems.

Bootstrapper::initContentSecurityPolicy() — Method in class Bootstrapper

Set up content security policy

Scopus::isNameAbbreviation() — Method in class Scopus

Is the provided text the abbreviation part of a name string?

ImporterClass in namespace VuFind\CSV

VuFind CSV importer configuration

ImporterConfigClass in namespace VuFind\CSV

VuFind CSV importer configuration

ImageClass in namespace VuFind\Captcha

Image CAPTCHA.

ImageFactoryClass in namespace VuFind\Captcha

Image CAPTCHA factory.

IntervalClass in namespace VuFind\Captcha

Interval CAPTCHA (requires an interval between actions or from start of session).

IntervalFactoryClass in namespace VuFind\Captcha

Factory for Interval CAPTCHA module.

$ Cart#itemsProperty in class Cart

Cart contents.

Cart::isFull() — Method in class Cart

Check whether the cart is full.

Cart::isEmpty() — Method in class Cart

Check whether the cart is empty.

Cart::isActive() — Method in class Cart

Check whether cart is enabled.

Cart::isActiveInSearch() — Method in class Cart

Process parameters and return the cart content.

Cart::init() — Method in class Cart

Initialize the cart model.

$ AbstractILSChannelProvider#ilsProperty in class AbstractILSChannelProvider

ILS connection

$ ListItems#idsProperty in class ListItems

IDs of lists to display

$ ListItems#initialListsToDisplayProperty in class ListItems

How many lists should we display before switching over to tokens?

AccountCapabilities::isScheduledSearchEnabled() — Method in class AccountCapabilities

Is scheduled search enabled?

AccountCapabilities::isAccountAvailable() — Method in class AccountCapabilities

Is a user account capable of saving data currently available?

AccountCapabilities::isRatingRemovalAllowed() — Method in class AccountCapabilities

Check if record ratings can be removed

$ PluginFactory#iniReaderProperty in class PluginFactory

INI file reader

$ Upgrade#inPlaceUpgradeProperty in class Upgrade

Are we upgrading files in place rather than creating them?

Upgrade::iniMerge() — Method in class Upgrade

Support function -- merge the contents of two arrays parsed from ini files.

Upgrade::isDefaultBulkExportOptions() — Method in class Upgrade

Is this a default BulkExport options setting?

$ WorldCatUtils#ipProperty in class WorldCatUtils

Current server IP address

WorldCatUtils::isUsefulNameChunk() — Method in class WorldCatUtils

Support function for getIdentitiesQuery(); is the provided name component worth considering as a first or last name?

IlsStatusMonitorClass in namespace VuFind\ContentBlock

Abstract base content block.

AbstractCover::isCacheAllowed() — Method in class AbstractCover

Are we allowed to cache images from this source?

$ LocalFile#imageExtensionsProperty in class LocalFile

Image file extensions to look for when using %anyimage% token.

AbstractBase::inLightbox() — Method in class AbstractBase

Are we currently in a lightbox context?

AbstractBase::ILLRequests() — Method in class AbstractBase

ILLRequests plugin

AbstractBase::ilsRecords() — Method in class AbstractBase

IlsRecords plugin

ILLRequestsTraitClass in namespace VuFind\Controller

ILL trait (for subclasses of AbstractRecord)

ILLRequestsTrait::illRequestAction() — Method in class ILLRequestsTrait

Action for dealing with ILL requests.

IndexControllerClass in namespace VuFind\Controller

Redirects the user to the appropriate default VuFind action.

IndexControllerFactoryClass in namespace VuFind\Controller

Index controller factory.

InstallControllerClass in namespace VuFind\Controller

Class controls VuFind auto-configuration.

InstallController::installBasicConfig() — Method in class InstallController

Copy the basic configuration file into position and report success or failure.

MyResearchController::isDuplicateOfSavedSearch() — Method in class MyResearchController

Is the provided search row a duplicate of a search that is already saved?

MyResearchController::illRequestsAction() — Method in class MyResearchController

Send list of ill requests to view

$ OAuth2Controller#identityRepositoryProperty in class OAuth2Controller

Identity repository

ILLRequestsClass in namespace VuFind\Controller\Plugin

Action helper to perform ILL request related actions

IlsRecordsClass in namespace VuFind\Controller\Plugin

Action helper to perform ILS record related actions

IlsRecordsFactoryClass in namespace VuFind\Controller\Plugin

Factory for IlsRecords controller plugin.

Permission::isAuthorized() — Method in class Permission

Check if a permission is authorized, returning a boolean value without applying any additional behavior.

ResultScroller::init() — Method in class ResultScroller

Initialize this result set scroller. This should only be called prior to displaying the results of a new search.

SummonController::injectSummonMessage() — Method in class SummonController

Use preDispatch event to add Summon message.

SummonrecordController::injectSummonMessage() — Method in class SummonrecordController

Use preDispatch event to add Summon message.

CookieManager::isSecure() — Method in class CookieManager

Are cookies set to "secure only" mode?

CookieManager::isHttpOnly() — Method in class CookieManager

Are cookies set to "HTTP only" mode?

$ Generator#imProperty in class Generator

Base for image

Generator::initImage() — Method in class Generator

Initialize the image in the object.

InitialTextClass in namespace VuFind\Cover\Layer

Initial cover text layer

$ Loader#isbnProperty in class Loader

User ISBN parameter

$ Loader#issnProperty in class Loader

User ISSN parameter

$ Loader#ismnProperty in class Loader

User ISMN parameter

$ OaiResumption#idProperty in class OaiResumption
$ Resource#idProperty in class Resource
$ Search#idProperty in class Search
$ User#idProperty in class User
$ UserCard#idProperty in class UserCard
$ UserList#idProperty in class UserList
UserList::isPublic() — Method in class UserList

Is this a public list?

ChangeTracker::index() — Method in class ChangeTracker

Update the change_tracker table to reflect that a record has been indexed.

Gateway::initializeFeatures() — Method in class Gateway

Initialize features

Search::initializeFeatures() — Method in class Search

Initialize features

$ OverdriveConnector#ilsAuthProperty in class OverdriveConnector

ILS Authorization

$ Demo#iconsProperty in class Demo

Possible icon values

ILSClass in namespace VuFind\Exception

ILS Exception

$ Feed#itemsPerPageProperty in class Feed

Items per page

$ Form#inputFilterProperty in class Form

Input filter

Form::isEnabled() — Method in class Form

Check if form enabled.

AbstractBase::isCollection() — Method in class AbstractBase

Identify whether the provided record is a collection.

Request::isValid() — Method in class Request

Check if a parameter is valid

$ LocaleSettings#initializedLocalesProperty in class LocaleSettings

Array of locales that have been initialized.

LocaleSettings::isRightToLeftLocale() — Method in class LocaleSettings

Identify whether a particular locale uses right-to-left layout.

LocaleSettings::isLocaleInitialized() — Method in class LocaleSettings

Is the locale already initialized?

TranslatableString::isTranslatable() — Method in class TranslatableString

Checks if the string can be translated

TranslatableStringInterface::isTranslatable() — Method in class TranslatableStringInterface

Checks if the string can be translated

Connection::initializeDriver() — Method in class Connection

Initialize the ILS driver.

Aleph::init() — Method in class Aleph

Initialize the driver.

Alma::init() — Method in class Alma

Initialize the driver.

Amicus::init() — Method in class Amicus

Initialize the driver.

DAIA::init() — Method in class DAIA

Initialize the driver.

$ Demo#idsInMyResearchProperty in class Demo

Should we return bib IDs in MyResearch responses?

$ Demo#ILLRequestsProperty in class Demo

Should we support ILLRequests?

$ Demo#instructorsProperty in class Demo

Instructors for use in course reserves.

Demo::init() — Method in class Demo

Initialize the driver.

Demo::isFailing() — Method in class Demo

Check for a simulated failure. Returns true for failure, false for success.

DriverInterface::init() — Method in class DriverInterface

Initialize the driver.

Evergreen::init() — Method in class Evergreen

Initialize the driver.

Folio::init() — Method in class Folio

Initialize the driver.

Folio::isHoldable() — Method in class Folio

Check item location against list of configured locations where holds should be offered

GeniePlus::init() — Method in class GeniePlus

Initialize the driver.

Horizon::init() — Method in class Horizon

Initialize the driver.

HorizonXMLAPI::init() — Method in class HorizonXMLAPI

Initialize the driver.

InnovativeClass in namespace VuFind\ILS\Driver

VuFind Connector for Innovative

Innovative::init() — Method in class Innovative

Initialize the driver.

$ Koha#ilsBaseUrlProperty in class Koha

ILS base URL

Koha::init() — Method in class Koha

Initialize the driver.

$ KohaILSDI#ilsBaseUrlProperty in class KohaILSDI

ILS base URL

KohaILSDI::init() — Method in class KohaILSDI

Initialize the driver.

KohaILSDI::initDb() — Method in class KohaILSDI

Initialize the DB driver.

$ KohaRest#itemStatusMappingsProperty in class KohaRest

Item status mappings

$ KohaRest#itemStatusMappingMethodsProperty in class KohaRest

Item status mapping methods used when the item status mappings above (or in the configuration file) don't contain a direct mapping.

KohaRest::init() — Method in class KohaRest

Initialize the driver.

KohaRest::itemHoldAllowed() — Method in class KohaRest

Check if an item is holdable

KohaRest::itemArticleRequestAllowed() — Method in class KohaRest

Check if an article request can be placed on the item

$ MultiBackend#ilsAuthProperty in class MultiBackend

ILS authenticator

MultiBackend::init() — Method in class MultiBackend

Initialize the driver.

NewGenLib::init() — Method in class NewGenLib

Initialize the driver.

NoILS::init() — Method in class NoILS

Initialize the driver.

PAIA::init() — Method in class PAIA

Initialize the driver.

Polaris::init() — Method in class Polaris

Initialize the driver.

Sample::init() — Method in class Sample

Initialize the driver.

Sierra::idStrip() — Method in class Sierra

Removes leading ".b" and trailing check digit from id numbers before querying the database with them

Sierra::init() — Method in class Sierra

Initialize the driver.

$ SierraRest#itemHoldsEnabledProperty in class SierraRest

Whether item holds are enabled

$ SierraRest#itemHoldExcludedItemCodesProperty in class SierraRest

Item codes for which item level hold is not allowed

$ SierraRest#itemStatusMappingsProperty in class SierraRest

Mappings from item status codes to VuFind strings

SierraRest::init() — Method in class SierraRest

Initialize the driver.

SierraRest::isHoldable() — Method in class SierraRest

Determine whether an item is holdable

SierraRest::itemHoldAllowed() — Method in class SierraRest

Check if an item is holdable

SierraRest::isPatronSpecificAccess() — Method in class SierraRest

Check if we re using a patron-specific access token

Symphony::init() — Method in class Symphony

Initialize the driver.

Unicorn::init() — Method in class Unicorn

Initialize the driver.

Virtua::init() — Method in class Virtua

Initialize the driver.

Voyager::init() — Method in class Voyager

Initialize the driver.

$ VoyagerRestful#itemHoldsEnabledProperty in class VoyagerRestful

Whether item holds are enabled

VoyagerRestful::init() — Method in class VoyagerRestful

Initialize the driver.

VoyagerRestful::isHoldable() — Method in class VoyagerRestful

Support method for VuFind Hold Logic. Take an array of status strings and determines whether or not an item is holdable based on the valid_hold_statuses settings in configuration file

VoyagerRestful::isBorrowable() — Method in class VoyagerRestful

Support method for VuFind Hold Logic. Takes an item type id and determines whether or not an item is borrowable based on the non_borrowable settings in configuration file

VoyagerRestful::isStorageRetrievalRequestAllowed() — Method in class VoyagerRestful

Support method for VuFind Storage Retrieval Request (Call Slip) Logic.

VoyagerRestful::isILLRequestAllowed() — Method in class VoyagerRestful

Support method for VuFind ILL Logic. Take a holdings row array and determine whether or not an ILL (UB) request is allowed.

VoyagerRestful::isRecordOnLoan() — Method in class VoyagerRestful

Check whether the given patron has the given bib record or its item on loan.

VoyagerRestful::itemsExist() — Method in class VoyagerRestful

Check whether items exist for the given BIB ID

VoyagerRestful::itemsAvailable() — Method in class VoyagerRestful

Check whether there are items available for loan for the given BIB ID

VoyagerRestful::isLocalInst() — Method in class VoyagerRestful

Support method: is this institution code a local one?

XCNCIP2::init() — Method in class XCNCIP2

Initialize the driver.

XCNCIP2::isPatronBlocked() — Method in class XCNCIP2

Helper function to distinguish if blocks are really blocking patron from actions on ILS, or if they are more like notifies

XCNCIP2::isAvailable() — Method in class XCNCIP2

Is an item available?

XCNCIP2::isRequestCancelled() — Method in class XCNCIP2

Is request cancelled?

XCNCIP2::isItemHoldable() — Method in class XCNCIP2

Check if item is holdable

XCNCIP2::invalidateResponseCache() — Method in class XCNCIP2

Invalidate L1 cache for responses

XCNCIP2::isNextItemTokenEmpty() — Method in class XCNCIP2

Check NextItemToken for emptiness

$ Holds#ilsAuthProperty in class Holds

ILS authenticator

$ TitleHolds#ilsAuthProperty in class TitleHolds

ILS authenticator

ImageLoaderClass in namespace VuFind

Base class for loading images (shared by Cover\Loader and QRCode\Loader)

$ ImageLoader#imageProperty in class ImageLoader

Property for storing raw image data; may be null if image is unavailable

$ Mailer#initialTransportProperty in class Mailer

A clone of $transport above. This can be used to reset the connection state in case transport doesn't support the disconnect method or it throws an exception (this can happen if the connection is stale and the connector tries to issue a QUIT message for clean disconnect).

IpAddressUtilsClass in namespace VuFind\Net

IP address utility functions.

IpAddressUtils::isInRange() — Method in class IpAddressUtils

Check if an IP address is in a range. Works also with mixed IPv4 and IPv6 addresses.

$ UserIpReader#ipFilterProperty in class UserIpReader

IP addresses to exclude from consideration

$ Server#iso8601Property in class Server

ISO-8601 date format

$ Server#idNamespaceProperty in class Server

Namespace used for ID prefixing (if any)

Server::init() — Method in class Server

Initialize settings

Server::identify() — Method in class Server

Respond to an Identify request:

Server::initializeMetadataFormats() — Method in class Server

Initialize data about metadata formats. (This is called on demand and is defined as a separate method to allow easy override by child classes).

Server::initializeSettings() — Method in class Server

Load data from the OAI section of config.ini. (This is called by the constructor and is only a separate method to allow easy override by child classes).

Server::isBadDate() — Method in class Server

Validate the from and until parameters for the listRecords method.

Auth::initializeSettings() — Method in class Auth

Load data from the OAI section of config.ini. (This is called by the constructor and is only a separate method to allow easy override by child classes).

$ ScopeEntity#ilsNeededProperty in class ScopeEntity

Whether the scope requires data from an ILS account

$ UserEntity#ilsProperty in class UserEntity

ILS connection

AbstractTokenRepository::isRevoked() — Method in class AbstractTokenRepository

Check if a token is revoked

AccessTokenRepository::isAccessTokenRevoked() — Method in class AccessTokenRepository

Check if the access token has been revoked.

AuthCodeRepository::isAuthCodeRevoked() — Method in class AuthCodeRepository

Check if the authentication code has been revoked.

IdentityRepositoryClass in namespace VuFind\OAuth2\Repository

OpenID Connect repository implementation.

$ IdentityRepository#ilsProperty in class IdentityRepository

ILS connection

IdentityRepositoryFactoryClass in namespace VuFind\OAuth2\Repository

IdentityRepository factory.

RefreshTokenRepository::isRefreshTokenRevoked() — Method in class RefreshTokenRepository

Check if the refresh token has been revoked.

AbstractResultsPassthrough::init() — Method in class AbstractResultsPassthrough

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

AbstractSummonRecommend::init() — Method in class AbstractSummonRecommend

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

AbstractSummonRecommendDeferred::init() — Method in class AbstractSummonRecommendDeferred

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

$ AlphaBrowseLink#indexProperty in class AlphaBrowseLink

Alphabrowse index to link to

AlphaBrowseLink::init() — Method in class AlphaBrowseLink

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

AuthorFacets::init() — Method in class AuthorFacets

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

AuthorInfo::init() — Method in class AuthorInfo

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

AuthorityRecommend::init() — Method in class AuthorityRecommend

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

AuthorityRecommend::isModeActive() — Method in class AuthorityRecommend

Is the specified mode configured to be active?

DOI::init() — Method in class DOI

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

DOI::isFullMatch() — Method in class DOI

Is the DOI returned by getDOI a match to the user's full search query?

DPLATerms::init() — Method in class DPLATerms

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

DPLATerms::isCollapsed() — Method in class DPLATerms

Return the list of facets configured to be collapsed

Deprecated::init() — Method in class Deprecated

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

EDSResultsDeferred::init() — Method in class EDSResultsDeferred

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

EuropeanaResults::init() — Method in class EuropeanaResults

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

EuropeanaResultsDeferred::init() — Method in class EuropeanaResultsDeferred

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

ExpandFacets::init() — Method in class ExpandFacets

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

ExternalSearch::init() — Method in class ExternalSearch

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

InjectConfigManagerFactoryClass in namespace VuFind\Recommend

Factory for instantiating recommendation modules with config plugin manager.

InjectResultsManagerFactoryClass in namespace VuFind\Recommend

Factory for instantiating recommendation modules with Results plugin manager.

InjectSearchRunnerFactoryClass in namespace VuFind\Recommend

Factory for instantiating recommendation modules with search runner.

Libraryh3lp::init() — Method in class Libraryh3lp

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

MapSelection::init() — Method in class MapSelection

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

OpenLibrarySubjects::init() — Method in class OpenLibrarySubjects

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

OpenLibrarySubjectsDeferred::init() — Method in class OpenLibrarySubjectsDeferred

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

PubDateVisAjax::init() — Method in class PubDateVisAjax

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

RandomRecommend::init() — Method in class RandomRecommend

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

RecommendInterface::init() — Method in class RecommendInterface

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

RecommendLinks::init() — Method in class RecommendLinks

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

RemoveFilters::init() — Method in class RemoveFilters

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

SearchObject::init() — Method in class SearchObject

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

SideFacets::init() — Method in class SideFacets

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

SideFacetsDeferred::init() — Method in class SideFacetsDeferred

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

SummonResultsDeferred::init() — Method in class SummonResultsDeferred

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

SummonTopics::init() — Method in class SummonTopics

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

SwitchQuery::init() — Method in class SwitchQuery

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

SwitchTab::init() — Method in class SwitchTab

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

SwitchType::init() — Method in class SwitchType

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

TopFacets::init() — Method in class TopFacets

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

VisualFacets::init() — Method in class VisualFacets

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

WorldCatIdentities::init() — Method in class WorldCatIdentities

Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).

AbstractBase::isRatingAllowed() — Method in class AbstractBase

Check if rating the record is allowed.

DefaultRecord::isCollection() — Method in class DefaultRecord

Get the value of whether or not this is a collection level record

EDS::itemIsExcluded() — Method in class EDS

Support method for getItems, used to apply filters.

HierarchyAwareTrait::isCollection() — Method in class HierarchyAwareTrait

Get the value of whether or not this is a collection level record

IlsAwareTraitClass in namespace VuFind\RecordDriver\Feature

ILS support for MARC and other types of records.

$ IlsAwareTrait#ilsProperty in class IlsAwareTrait

ILS connection

$ IlsAwareTrait#ilsBackendsProperty in class IlsAwareTrait

Backends with ILS integration.

IlsAwareDelegatorFactoryClass in namespace VuFind\RecordDriver

ILS aware delegator factory

SolrOverdrive::isLoggedIn() — Method in class SolrOverdrive

Is Logged in

SolrOverdrive::isCheckedOut() — Method in class SolrOverdrive

Is Checked Out

SolrOverdrive::isHeld() — Method in class SolrOverdrive

Is Held Checks to see if the current record is on hold through Overcdrive.

Summon::isOpenAccess() — Method in class Summon

Is this an open access record?

AbstractBase::isActive() — Method in class AbstractBase

Is this tab active?

AbstractBase::isVisible() — Method in class AbstractBase

Is this tab initially visible?

AbstractContent::isActive() — Method in class AbstractContent

Is this tab active?

ComponentParts::isActive() — Method in class ComponentParts

Is this tab active?

Formats::isActive() — Method in class Formats

Is this tab active?

HierarchyTree::isActive() — Method in class HierarchyTree

Is this tab active?

HierarchyTree::isFullHierarchyVisible() — Method in class HierarchyTree

Should we display the full tree, or just a partial tree?

HoldingsILS::isActive() — Method in class HoldingsILS

Is this tab active?

HoldingsWorldCat::isActive() — Method in class HoldingsWorldCat

Is this tab active?

Map::isActive() — Method in class Map

Is this tab active?

Preview::isActive() — Method in class Preview

Is this tab active?

Preview::isVisible() — Method in class Preview

Is this tab initially visible?

TOC::isActive() — Method in class TOC

Is this tab active?

TabInterface::isActive() — Method in class TabInterface

Is this tab active?

TabManager::initializeCurrentContext() — Method in class TabManager

Initialize the current context (if not already initialized).

UserComments::isCaptchaActive() — Method in class UserComments

Is Captcha active?

UserComments::isActive() — Method in class UserComments

Is this tab active?

Versions::isActive() — Method in class Versions

Is this tab active?

Cache::isPrimary() — Method in class Cache

Convenience method for checking if cache is used as primary data data source

Cache::isFallback() — Method in class Cache

Convenience method for checking if cache is used as fallback data source

Cache::isCachable() — Method in class Cache

Check whether a record source is cachable

$ SourceAndIdList#idsProperty in class SourceAndIdList

Processed ID data.

Bookplate::init() — Method in class Bookplate

Establishes base settings for bookplates.

Channels::init() — Method in class Channels

Establishes base settings for making recommendations.

Deprecated::init() — Method in class Deprecated

Establishes base settings for making recommendations.

RelatedInterface::init() — Method in class RelatedInterface

Establishes base settings for making recommendations.

Similar::init() — Method in class Similar

Establishes base settings for making recommendations.

WorldCatSimilar::init() — Method in class WorldCatSimilar

Establishes base settings for making recommendations.

$ CsvReader#instructorsProperty in class CsvReader

Instructor data loaded from files

$ Alma#ignoredFilterReasonsProperty in class Alma

List of filter reasons that are ignored (displayed regardless of filtering)

PermissionManager::isAuthorized() — Method in class PermissionManager

Determine if the user is authorized in a certain context or not

InjectAuthorizationServiceFactoryClass in namespace VuFind\Role\PermissionProvider

Factory for instantiating permission providers with authorization service.

InjectRequestFactoryClass in namespace VuFind\Role\PermissionProvider

Factory for instantiating permission providers with request object.

IpRangeClass in namespace VuFind\Role\PermissionProvider

IpRange permission provider for VuFind.

$ IpRange#ipAddressUtilsProperty in class IpRange

IpAddressUtils object

IpRangeFactoryClass in namespace VuFind\Role\PermissionProvider

Factory for instantiating IpRange permission provider.

IpRegExClass in namespace VuFind\Role\PermissionProvider

IpRegEx permission provider for VuFind.

IpRegExFactoryClass in namespace VuFind\Role\PermissionProvider

Factory for instantiating IpRegEx permission provider.

$ Shibboleth#idpServerParamProperty in class Shibboleth

Server param with the identity provider entityID

HierarchicalFacetHelperInterface::isDeepestFacetLevel() — Method in class HierarchicalFacetHelperInterface

Check if the given value is the deepest level in the facet list.

Params::initFromRequest() — Method in class Params

Pull the search parameters

Params::initShards() — Method in class Params

Pull shard parameters from the request or set defaults

Params::initLimit() — Method in class Params

Pull the page size parameter or set to default

Params::initPage() — Method in class Params

Pull the page parameter

Params::initSearch() — Method in class Params

Initialize the object's search settings from a request object.

Params::initBasicSearch() — Method in class Params

Support method for initSearch() -- handle basic settings.

Params::initAdvancedSearch() — Method in class Params

Support method for initSearch() -- handle advanced settings. Advanced searches have numeric subscripts on the lookfor and type parameters -- this is how they are distinguished from basic searches.

Params::initSort() — Method in class Params

Get the value for which type of sorting to use

Params::initView() — Method in class Params

Get the value for which results view to use

Params::isAdvancedFilter() — Method in class Params

Detects if a filter is advanced (true) or simple (false). An advanced filter is currently defined as one surrounded by parentheses (possibly with a leading exclusion operator), while a simple filter is of the form field:value. Advanced filters are used to express more complex queries, such as combining multiple values from multiple fields using boolean operators.

Params::initRangeFilters() — Method in class Params

Initialize all range filters.

Params::initGenericRangeFilters() — Method in class Params

Support method for initFilters() -- initialize range filters. Factored out as a separate method so that it can be more easily overridden by child classes.

Params::initDateFilters() — Method in class Params

Support method for initFilters() -- initialize year-based date filters.

Params::initFullDateFilters() — Method in class Params

Support method for initFilters() -- initialize year/month/day-based date filters. Factored out as a separate method so that it can be more easily overridden by child classes.

Params::initNumericRangeFilters() — Method in class Params

Support method for initFilters() -- initialize numeric range filters. Factored out as a separate method so that it can be more easily overridden by child classes.

Params::initFilters() — Method in class Params

Add filters to the object based on values found in the request object.

Params::initHiddenFilters() — Method in class Params

Add hidden filters to the object based on values found in the request object.

Params::initFacetList() — Method in class Params

Initialize facet settings for the specified configuration sections.

Params::initCheckboxFacets() — Method in class Params

Initialize checkbox facet settings for the specified configuration sections.

Results::isSavedSearch() — Method in class Results

Is the current search saved in the database?

Params::initFromRequest() — Method in class Params

Pull the search parameters

Params::initSearch() — Method in class Params

Initialize the object's search settings from a request object.

Params::initSort() — Method in class Params

Get the value for which type of sorting to use

Params::isBlenderFilter() — Method in class Params

Check if the filter is a special Blender filter

Params::initFromRequest() — Method in class Params

Pull the search parameters

SummonBackendFactory::isAuthed() — Method in class SummonBackendFactory

Is the current user of the Summon connector authenticated?

Params::initFilters() — Method in class Params

Add filters to the object based on values found in the request object.

$ Minified#idProperty in class Minified

Search ID

$ Minified#iProperty in class Minified

Search start time

Params::initSearch() — Method in class Params

Initialize the object's search settings from a request object.

NormalizedSearch::isEquivalentToMinifiedSearch() — Method in class NormalizedSearch

Is this search equivalent to the provided minified search?

ViewOptionsTrait::initViewOptions() — Method in class ViewOptionsTrait

Set up the view options.

FacetLimitTrait::initFacetLimitsFromConfig() — Method in class FacetLimitTrait

Initialize facet limit from a Config object.

FacetRestrictionsTrait::initFacetRestrictionsFromConfig() — Method in class FacetRestrictionsTrait

Initialize facet prefix and matches from a Config object.

InjectOnCampusListenerClass in namespace VuFind\Search\Primo

OnCampus listener.

$ InjectOnCampusListener#isOnCampusProperty in class InjectOnCampusListener

Is user on campus or not?

$ PrimoPermissionHandler#instCodeProperty in class PrimoPermissionHandler

Institution code applicable for the user

PrimoPermissionHandler::instCodeExists() — Method in class PrimoPermissionHandler

Determine if a institution code is set in config file

Params::initAdvancedFacets() — Method in class Params

Initialize facet settings for the advanced search screen.

Params::initHomePageFacets() — Method in class Params

Initialize facet settings for the home page.

Params::initFromRequest() — Method in class Params

Set parameters based on a search object

Params::initBasicSearch() — Method in class Params

Support method for _initSearch() -- handle basic settings.

Params::initView() — Method in class Params

Initialize view

Results::isSavedSearch() — Method in class Results

Is the current search saved in the database?

Params::initBasicSearch() — Method in class Params

Support method for _initSearch() -- handle basic settings.

Results::isSavedSearch() — Method in class Results

Is the current search saved in the database?

Params::initFromRecordDriver() — Method in class Params

Pull the search parameters from the query and set up additional options using a record driver representing a collection.

$ CustomFilterListener#invertedFiltersProperty in class CustomFilterListener

Inverted filters

HierarchicalFacetHelper::isDeepestFacetLevel() — Method in class HierarchicalFacetHelper

Check if the given value is the deepest level in the facet list.

InjectConditionalFilterListenerClass in namespace VuFind\Search\Solr

Conditional Filter listener.

InjectHighlightingListenerClass in namespace VuFind\Search\Solr

Solr highlighting listener.

InjectSpellingListenerClass in namespace VuFind\Search\Solr

Solr spelling listener.

$ Params#indexSortedFacetsProperty in class Params

Sorting order of single facet by index

Params::initSearch() — Method in class Params

Initialize the object's search settings from a request object.

Params::initFacetList() — Method in class Params

Initialize facet settings for the specified configuration sections.

Params::initAdvancedFacets() — Method in class Params

Initialize facet settings for the advanced search screen.

Params::initHomePageFacets() — Method in class Params

Initialize facet settings for the home page.

Params::initFilters() — Method in class Params

Add filters to the object based on values found in the request object.

Params::initFacetList() — Method in class Params

Initialize facet settings for the specified configuration sections.

Params::initAdvancedFacets() — Method in class Params

Initialize facet settings for the advanced search screen.

Params::initHomePageFacets() — Method in class Params

Initialize facet settings for the home page.

Params::isFuzzyTagSearch() — Method in class Params

Is this a fuzzy search?

Params::initFromRequest() — Method in class Params

Pull the search parameters

UrlQueryHelper::isQuerySuppressed() — Method in class UrlQueryHelper

Is query suppressed?

ServiceInitializer::isCacheEnabled() — Method in class ServiceInitializer

Check if the record cache is enabled within a service manager.

Settings::isWriteDisabled() — Method in class Settings

Have session writes been disabled?

AbstractFile::isEmpty() — Method in class AbstractFile

Check if the sitemap is empty

$ Generator#indexFileProperty in class Generator

Filename of sitemap index

$ ContentPages#includedFilesProperty in class ContentPages

Patterns of files to be included

IndexClass in namespace VuFind\Sitemap\Plugin

Index-based generator plugin

$ Index#idFetcherProperty in class Index

Helper for fetching IDs from the search service.

IndexFactoryClass in namespace VuFind\Sitemap\Plugin

Index-based generator plugin factory

$ Auth#ilsAuthenticatorProperty in class Auth

ILS Authenticator

Auth::isLoggedIn() — Method in class Auth

Checks whether the user is logged in.

Citation::isNameSuffix() — Method in class Citation

Is the string a valid name suffix?

Citation::isDateRange() — Method in class Citation

Is the string a date range?

Citation::isPunctuated() — Method in class Citation

Does the string end in punctuation that we want to retain?

CookieConsent::isEnabled() — Method in class CookieConsent

Check if the cookie consent mechanism is enabled

CookieConsent::isCategoryAccepted() — Method in class CookieConsent

Check if a cookie category is accepted

CookieConsent::isServiceAllowed() — Method in class CookieConsent

Check if a VuFind service is allowed

Doi::isActive() — Method in class Doi

Public method to check whether OpenURLs are active for current record

IconClass in namespace VuFind\View\Helper\Root

Icon view helper

$ Icon#iconMapProperty in class Icon

Transforming map

IconFactoryClass in namespace VuFind\View\Helper\Root

Icon helper factory.

IlsClass in namespace VuFind\View\Helper\Root

ILS (integrated library system) view helper

IlsFactoryClass in namespace VuFind\View\Helper\Root

Ils helper factory.

$ JsIcons#iconHelperProperty in class JsIcons

Icon helper

$ KeepAlive#intervalProperty in class KeepAlive

Keep-alive interval in seconds or 0 if disabled

OpenUrl::imageBasedLinkingIsActive() — Method in class OpenUrl

Public method to check if ImageBased Linking is enabled

OpenUrl::isActive() — Method in class OpenUrl

Public method to check whether OpenURLs are active for current record

SyndeticsPlus::isActive() — Method in class SyndeticsPlus

Is SyndeticsPlus active?

VuFind::implode() — Method in class VuFind

Proxy the implode PHP function for use in XSL transformation.

VuFind::isInvertedName() — Method in class VuFind

Is the provided name inverted ("Last, First") or not ("First Last")?

VuFind::invertName() — Method in class VuFind

Invert "Firstname Lastname" authors into "Lastname, Firstname."

VuFind::invertNames() — Method in class VuFind

Call invertName on all matching elements; return a DOMDocument with a name tag for each inverted name.

ImporterClass in namespace VuFind\XSLT

VuFind XSLT importer

Importer::initProcessor() — Method in class Importer

Initialize an XSLT processor using settings from the user-specified properties file.

J

JsonListenerClass in namespace KnihovnyCz\Search\EDS\Backend

EBSCO EDS API JSON parser

JsonFacetListenerClass in namespace KnihovnyCz\Search\Solr

Solr hierarchical facet handling listener.

$ Params#jsonFacetsProperty in class Params

Array of array parameters

$ ApiTrait#jsonpCallbackProperty in class ApiTrait

Callback function in JSONP mode

$ ApiTrait#jsonPrettyPrintProperty in class ApiTrait

Whether to pretty-print JSON

JumpToRecordTestClass in namespace VuFindTest\Mink

"Jump to record" test class.

JopTestClass in namespace VuFindTest\Resolver\Driver

Jop resolver driver test

JsTranslationsTestClass in namespace VuFindTest\View\Helper\Root

ShortenUrl view helper Test Class

$ ResourceContainer#jsProperty in class ResourceContainer

Javascript files

AjaxController::jsonAction() — Method in class AjaxController

Make an AJAX call with a JSON-formatted response.

OAuth2Controller::jwksAction() — Method in class OAuth2Controller

Action to retrieve JSON Web Keys

JsonClass in namespace VuFind\Hierarchy\TreeDataFormatter

Hierarchy Tree Data Formatter (JSON)

JSTreeClass in namespace VuFind\Hierarchy\TreeRenderer

Hierarchy Tree Renderer

JSTree::jsonToHTML() — Method in class JSTree

Convert JSTree JSON structure to HTML

JSTreeFactoryClass in namespace VuFind\Hierarchy\TreeRenderer

JSTree hierarchy tree renderer plugin factory.

AccessTokenEntity::jsonSerialize() — Method in class AccessTokenEntity

Serialize to a JSON string

AuthCodeEntity::jsonSerialize() — Method in class AuthCodeEntity

Serialize to a JSON string

RefreshTokenEntity::jsonSerialize() — Method in class RefreshTokenEntity

Serialize to a JSON string

JopClass in namespace VuFind\Resolver\Driver

JOP Link Resolver Driver

JopFactoryClass in namespace VuFind\Resolver\Driver

Factory for JOP resolver driver.

Captcha::js() — Method in class Captcha

Get list of URLs with JS dependancies to load for the active CAPTCHA type.

JsIconsClass in namespace VuFind\View\Helper\Root

JsIcons helper for passing icon HTML to Javascript

JsIconsFactoryClass in namespace VuFind\View\Helper\Root

JsIcons helper factory.

JsTranslationsClass in namespace VuFind\View\Helper\Root

JsTranslations helper for passing translation text to Javascript

JsTranslationsFactoryClass in namespace VuFind\View\Helper\Root

JsTranslations helper factory.

K

KohaRestClass in namespace KnihovnyCz\ILS\Driver

Class KohaRest

KohaRest1905Class in namespace KnihovnyCz\ILS\Driver

VuFind Driver for Koha, using REST API

$ DeleteDocument#keysProperty in class DeleteDocument

Unique keys to delete.

NamedList::key() — Method in class NamedList

Return current element name.

AbstractRecordCollection::key() — Method in class AbstractRecordCollection

Return current collection index.

KeepAliveTestClass in namespace VuFindTest\AjaxHandler

KeepAlive test class.

KohaILSDITestClass in namespace VuFindTest\ILS\Driver

Class KohaILSDITest

KohaTestClass in namespace VuFindTest\ILS\Driver

ILS driver test

KeepAliveClass in namespace VuFind\AjaxHandler

"Keep Alive" AJAX handler

KeepAliveFactoryClass in namespace VuFind\AjaxHandler

Factory for KeepAlive AJAX handler.

KeyGeneratorTraitClass in namespace VuFind\Cache

VuFind Cache Key Generator Trait

KohaClass in namespace VuFind\ILS\Driver

VuFind Driver for Koha (version: 3.02)

KohaILSDIClass in namespace VuFind\ILS\Driver

VuFind Driver for Koha, using web APIs (ILSDI)

KohaRestClass in namespace VuFind\ILS\Driver

VuFind Driver for Koha, using REST API

KohaRestFactoryClass in namespace VuFind\ILS\Driver

Factory for KohaRest ILS driver.

$ CollectionSideFacets#keywordFilterProperty in class CollectionSideFacets

Is the keyword filter box active?

CollectionSideFacets::keywordFilterEnabled() — Method in class CollectionSideFacets

Is the keyword filter box enabled?

$ EuropeanaResults#keyProperty in class EuropeanaResults

API key

$ AddThis#keyProperty in class AddThis

AddThis key (false if disabled)

$ GoogleAnalytics#keyProperty in class GoogleAnalytics

API key (false if disabled)

KeepAliveClass in namespace VuFind\View\Helper\Root

KeepAlive view helper

KeepAliveFactoryClass in namespace VuFind\View\Helper\Root

KeepAlive helper factory.

L

$ XCNCIP2Test#loginTestsProperty in class XCNCIP2Test
XCNCIP2Test::loadResponse() — Method in class XCNCIP2Test

Load response from file

Manager::logout() — Method in class Manager

Log out the current user.

$ SolrPrefixHandler#limitProperty in class SolrPrefixHandler

Facet limit, can be overridden in subclasses

$ SolrPrefixSorted#limitProperty in class SolrPrefixSorted

Facet limit, can be overridden in subclasses

PluginFactory::loadConfigFromDb() — Method in class PluginFactory

Load the specified configuration file from database

$ AbstractDbAwaredRecordIds#listRowProperty in class AbstractDbAwaredRecordIds

List row

$ AbstractDbAwaredRecordIds#listParamsProperty in class AbstractDbAwaredRecordIds

Params for selecting list

$ AbstractDbAwaredRecordIds#listTableNameProperty in class AbstractDbAwaredRecordIds

Table for main list

$ AbstractDbAwaredRecordIds#limitProperty in class AbstractDbAwaredRecordIds
Limit
AbstractDbAwaredRecordIds::loadRecords() — Method in class AbstractDbAwaredRecordIds

Load records in batch

$ UserList#listIdProperty in class UserList

User list id

$ UserList#listTableNameProperty in class UserList

Table for main list

ObalkyKnih::loadByIsbn() — Method in class ObalkyKnih

This method is responsible for generating fake TOC data for testing purposes.

EmbeddedController::librariesAction() — Method in class EmbeddedController

Display directory of libraries

HoldsController::listAction() — Method in class HoldsController

Send list of holds to view

HoldsController::listAjaxAction() — Method in class HoldsController

Send list of holds to view

LibraryCardsControllerClass in namespace KnihovnyCz\Controller

Class LibraryCardsController

MyResearchController::logoutAction() — Method in class MyResearchController

Logout Action

MyResearchController::logoutWarningAction() — Method in class MyResearchController

Logout Warning Action

MyResearchZiskejEddController::listAjaxAction() — Method in class MyResearchZiskejEddController

Return tickets for selected library card

MyResearchZiskejMvsController::listAjaxAction() — Method in class MyResearchZiskejMvsController

Return tickets for selected library card

$ ResultScroller#lastSearchProperty in class ResultScroller
Results
$ User#lastnameProperty in class User
$ User#last_loginProperty in class User
$ User#last_languageProperty in class User
$ RecommendOtherPortals#linksProperty in class RecommendOtherPortals
$ SolrDefault#libraryIdMappingsProperty in class SolrDefault

Library id mappings (by source)

LibraryBranchesClass in namespace KnihovnyCz\RecordTab

Class LibraryBranches

LibraryContactsClass in namespace KnihovnyCz\RecordTab

Class LibraryContacts

LibraryInfoClass in namespace KnihovnyCz\RecordTab

Class LibraryInfo

LibraryServicesClass in namespace KnihovnyCz\RecordTab

Class LibraryServices

LoaderClass in namespace KnihovnyCz\Record

Record loader

Loader::load() — Method in class Loader

Given an ID and record source, load the requested record object.

LoaderFactoryClass in namespace KnihovnyCz\Record

Record loader factory.

LinksClass in namespace KnihovnyCz\Related

Class Links

$ Links#linksProperty in class Links
Links
$ Links#labelProperty in class Links

Module label

$ JsonListener#longFieldsProperty in class JsonListener
PerformanceLogger::log() — Method in class PerformanceLogger

Log response

$ MultiplyingDeduplicationListener#listOfFieldsProperty in class MultiplyingDeduplicationListener

List of fields to return from Solr

LinkServiceAbstractBaseClass in namespace KnihovnyCz\Service

Abstract class LinkServiceAbstractBase

LinkServiceInterfaceClass in namespace KnihovnyCz\Service

Interface LinkServiceInterface

LibrariesApiLookforClass in namespace KnihovnyCz\View\Helper\KnihovnyCz

Class LibrariesApiLookfor

SplitText::last() — Method in class SplitText

Return last part of text

TagsController::listAction() — Method in class TagsController

List Tags

$ AbstractCommand#languageDirProperty in class AbstractCommand

Language directory

$ NotifyCommand#limitProperty in class NotifyCommand

Number of results to retrieve when performing searches

$ NotifyCommand#localeSettingsProperty in class NotifyCommand

Locale settings object

LintMarcCommandClass in namespace VuFindConsole\Command\Util

Console command: Lint MARC records.

DevtoolsController::languageAction() — Method in class DevtoolsController

Language action

LanguageHelperClass in namespace VuFindDevTools

Language Helper for Development Tools Controller

$ LanguageHelper#loaderProperty in class LanguageHelper

Language loader

LanguageHelper::loadLanguage() — Method in class LanguageHelper

Load a language, including text domains.

Backend::lookupDoi() — Method in class Backend

Perform a DOI lookup

Backend::lookupIssns() — Method in class Backend

Perform an ISSN lookup.

LookupDoiCommandClass in namespace VuFindSearch\Backend\BrowZine\Command

Command to look up a DOI in the BrowZine backend.

LookupIssnsCommandClass in namespace VuFindSearch\Backend\BrowZine\Command

Command to look up ISSNs in the BrowZine backend.

$ Connector#libraryIdProperty in class Connector

The library ID number to use

Connector::lookupDoi() — Method in class Connector

Perform a DOI lookup

Connector::lookupIssns() — Method in class Connector

Perform an ISSN lookup.

$ SearchRequestModel#limitersProperty in class SearchRequestModel

Options to limit the results by

$ DeepPagingException#legalPageProperty in class DeepPagingException

A legal page number.

ConnectorCacheTrait::logCacheWarning() — Method in class ConnectorCacheTrait

Log a warning message

ConnectorCacheTrait::logCacheDebug() — Method in class ConnectorCacheTrait

Log a debug message

LuceneSyntaxHelperClass in namespace VuFindSearch\Backend\Solr

Lucene query syntax helper class.

$ QueryBuilder#luceneHelperProperty in class QueryBuilder

Lucene syntax helper

$ NamedList#listProperty in class NamedList

The named list.

BackendTest::loadResponse() — Method in class BackendTest

Load a Summon response as fixture.

$ QueryBuilder#luceneHelperProperty in class QueryBuilder

Lucene syntax helper

$ AlphabeticBrowseCommand#limitProperty in class AlphabeticBrowseCommand

Number of results to return on each page.

$ QueryOffsetLimitTrait#limitProperty in class QueryOffsetLimitTrait

Search limit.

$ RandomCommand#limitProperty in class RandomCommand

Search limit.

$ TermsCommand#limitProperty in class TermsCommand

Maximum number of terms.

LogicExceptionClass in namespace VuFindSearch\Exception

Logic exception.

$ RecordTrait#labelsProperty in class RecordTrait

Labels for the record

LDAPTestClass in namespace VuFindTest\Auth

LDAP authentication test class.

LookupDoiCommandTestClass in namespace VuFindTest\Backend\BrowZine\Command

Unit tests for LookupDoiCommand.

LookupIssnsCommandTestClass in namespace VuFindTest\Backend\BrowZine\Command

Unit tests for LookupIssnsCommand.

BackendTest::loadResponse() — Method in class BackendTest

Load a response as fixture.

BackendTest::loadResponse() — Method in class BackendTest

Load a response as fixture.

BackendTest::loadResponse() — Method in class BackendTest

Load a response as fixture.

BackendTest::loadResponse() — Method in class BackendTest

Load a WorldCat response as fixture.

BackendTest::loadResponse() — Method in class BackendTest

Load a SOLR response as fixture.

LuceneSyntaxHelperTestClass in namespace VuFindTest\Backend\Solr

Unit tests for Lucene syntax helper

BackendTest::loadResponse() — Method in class BackendTest

Load a WorldCat response as fixture.

$ CartTest#loaderProperty in class CartTest

Mock record loader

$ AddUsingTemplateCommandTest#languageFixtureDirProperty in class AddUsingTemplateCommandTest

Language fixture directory

$ CopyStringCommandTest#languageFixtureDirProperty in class CopyStringCommandTest

Language fixture directory

$ DeleteCommandTest#languageFixtureDirProperty in class DeleteCommandTest

Language fixture directory

$ NormalizeCommandTest#languageFixtureDirProperty in class NormalizeCommandTest

Language fixture directory

LintMarcCommandTestClass in namespace VuFindTest\Command\Util

LintMarc command test.

LocatorTestClass in namespace VuFindTest\Config

Config Locator Test Class

LibraryThingTestClass in namespace VuFindTest\Content\Covers

Unit tests for LibraryThing cover loader.

LanguageHelperTestClass in namespace VuFindTest\Controller

Unit tests for language helper.

LoaderTestClass in namespace VuFindTest\Cover

Cover Loader Test Class

LiveDatabaseTraitClass in namespace VuFindTest\Feature

Mix-in for accessing a real database during testing.

$ LiveDatabaseTrait#liveTableManagerProperty in class LiveDatabaseTrait

Table manager connected to live database.

LiveDetectionTraitClass in namespace VuFindTest\Feature

Mix-in for detecting whether a live test environment is currently running.

LiveSolrTraitClass in namespace VuFindTest\Feature

Mix-in for accessing a real Solr instance during testing.

$ LiveSolrTrait#liveSolrContainerProperty in class LiveSolrTrait

Container for services related to live Solr connectivity.

LocaleDetectorFactoryTestClass in namespace VuFindTest\I18n\Locale

LocaleDetectorFactory Test Class

LocaleSettingsTestClass in namespace VuFindTest\I18n\Locale

LocaleSettings Test Class

AlephTest::loadResponse() — Method in class AlephTest

Load response from file

ILSMockTrait::loginIsHidden() — Method in class ILSMockTrait
$ NoILSTest#loaderProperty in class NoILSTest

Mock record loader

$ XCNCIP2Test#loginTestsProperty in class XCNCIP2Test

Test definition for testPatronLogin

XCNCIP2Test::loadResponse() — Method in class XCNCIP2Test

Load response from file

MinkTestCase::logWarning() — Method in class MinkTestCase

Log a warning message

LoggerTestClass in namespace VuFindTest\Log

Logger Test Class

AccountMenuTest::login() — Method in class AccountMenuTest

Utility class to login

LinkResolverTestClass in namespace VuFindTest\Mink

Mink link resolver test class.

ListViewsTestClass in namespace VuFindTest\Mink

List views (i.e. tabs/accordion) test class.

ListViewsTest::localStorageDance() — Method in class ListViewsTest

Test localStorage saving from tab mode.

$ SearchLimitTest#limitControlSelectorProperty in class SearchLimitTest

Selector for limit control

LoaderTestClass in namespace VuFindTest\QRCode

QR Code Loader Test Class

LoaderTestClass in namespace VuFindTest\Record

Record loader tests.

$ MultiIndexListenerTest#listenerProperty in class MultiIndexListenerTest

Prepare listener.

$ CurrencyFormatterTest#localeProperty in class CurrencyFormatterTest

Locale (for restoration after testing)

LinkifyTestClass in namespace VuFindTest\View\Helper\Root

Linkify Test Class

$ LinkifyTest#linkifyProperty in class LinkifyTest

Linkify helper being tested

RecordTest::loadRecordFixture() — Method in class RecordTest

Load a fixture file.

$ SafeMoneyFormatTest#localeProperty in class SafeMoneyFormatTest

Locale (for restoration after testing)

VuFindGeoTest::log() — Method in class VuFindGeoTest
AbstractCssPreCompiler::logMessage() — Method in class AbstractCssPreCompiler

Log a message to the console

$ AbstractThemeUtility#lastErrorProperty in class AbstractThemeUtility

Last error message

$ ResourceContainer#lessProperty in class ResourceContainer

Less CSS files

ThemeInfo::loadThemeConfig() — Method in class ThemeInfo

Load configuration for the specified theme (and its mixins, if any) into the allThemeInfo property.

$ AbstractUserRequestAction#lookupMethodProperty in class AbstractUserRequestAction

ILS driver method for data retrieval.

$ GetRecordCommentsAsHTML#loaderProperty in class GetRecordCommentsAsHTML

Record loader

$ GetUserHolds#lookupMethodProperty in class GetUserHolds

ILS driver method for data retrieval.

$ GetUserILLRequests#lookupMethodProperty in class GetUserILLRequests

ILS driver method for data retrieval.

$ GetUserStorageRetrievalRequests#lookupMethodProperty in class GetUserStorageRetrievalRequests

ILS driver method for data retrieval.

$ TagRecord#loaderProperty in class TagRecord

Record loader

AbstractBase::logout() — Method in class AbstractBase

Perform cleanup at logout time.

CAS::logout() — Method in class CAS

Perform cleanup at logout time.

ChoiceAuth::logout() — Method in class ChoiceAuth

Perform cleanup at logout time.

$ EmailAuthenticator#loginRequestValidTimeProperty in class EmailAuthenticator

How long a login request is considered to be valid (seconds)

LDAPClass in namespace VuFind\Auth

LDAP authentication class

$ Manager#legalAuthOptionsProperty in class Manager

List of values allowed to be set into $activeAuth

Manager::loginEnabled() — Method in class Manager

Is login currently allowed?

Manager::logout() — Method in class Manager

Log out the current user.

Manager::login() — Method in class Manager

Try to log in the user using current query parameters; return User object on success, throws exception on failure.

Shibboleth::logout() — Method in class Shibboleth

Perform cleanup at logout time.

$ SolrPrefix#limitProperty in class SolrPrefix

Facet limit, can be overridden in subclasses

LaminasBaseClass in namespace VuFind\Captcha

Laminas base CAPTCHA

$ ReCaptcha#languageProperty in class ReCaptcha
Language
$ ChannelLoader#localeProperty in class ChannelLoader

Current locale (used for caching)

ListItemsClass in namespace VuFind\ChannelProvider

"List items" channel provider.

ListItemsFactoryClass in namespace VuFind\ChannelProvider

Factory for ListItems channel provider.

LocatorClass in namespace VuFind\Config

VuFind Configuration Locator - A static compatibility wrapper around PathResolver

$ PathResolver#localConfigDirStackProperty in class PathResolver

Local configuration directory stack. Local configuration files are searched for in all directories until found, starting from the last entry.

PluginFactory::loadConfigFile() — Method in class PluginFactory

Load the specified configuration file.

Upgrade::loadOldBaseConfig() — Method in class Upgrade

Load the old config.ini settings.

Upgrade::loadConfigs() — Method in class Upgrade

Load all of the user's existing configurations.

$ Oracle#lastErrorProperty in class Oracle

Error information - message

$ Oracle#lastErrorTypeProperty in class Oracle

Error information - type

$ Oracle#lastErrorFieldsProperty in class Oracle

Error information - bind params

$ Oracle#lastSqlProperty in class Oracle

Error information - SQL attempted

$ Wikipedia#langProperty in class Wikipedia

Selected language

$ Channels#loaderProperty in class Channels

Channel loader

AbstractBase::loadByIsbn() — Method in class AbstractBase

Load results for a particular API key and ISBN.

Demo::loadByIsbn() — Method in class Demo

This method is responsible for generating fake author note data for testing purposes.

Syndetics::loadByIsbn() — Method in class Syndetics

This method is responsible for connecting to Syndetics and abstracting author notes.

LibraryThingClass in namespace VuFind\Content\Covers

LibraryThing cover content loader.

LocalFileClass in namespace VuFind\Content\Covers

Local file cover content loader.

Deprecated::loadByIsbn() — Method in class Deprecated

Return empty data.

Demo::loadByIsbn() — Method in class Demo

This method is responsible for generating fake author note data for testing purposes.

Syndetics::loadByIsbn() — Method in class Syndetics

This method is responsible for connecting to Syndetics and abstracting excerpts.

LoaderClass in namespace VuFind\Content

Third-party content loader

$ Loader#loaderProperty in class Loader

Plug-in loader

Loader::loadByIsbn() — Method in class Loader

Retrieve results for the providers specified.

$ PageLocator#languageProperty in class PageLocator

Current language

Booksite::loadByIsbn() — Method in class Booksite
Booksite
Demo::loadByIsbn() — Method in class Demo

This method is responsible for generating fake author note data for testing purposes.

Guardian::loadByIsbn() — Method in class Guardian

Guardian Reviews

Syndetics::loadByIsbn() — Method in class Syndetics

This method is responsible for connecting to Syndetics and abstracting reviews from multiple providers.

Demo::loadByIsbn() — Method in class Demo

This method is responsible for generating fake summary data for testing purposes.

Syndetics::loadByIsbn() — Method in class Syndetics

This method is responsible for connecting to Syndetics for summaries.

Demo::loadByIsbn() — Method in class Demo

This method is responsible for generating fake TOC data for testing purposes.

Syndetics::loadByIsbn() — Method in class Syndetics

This method is responsible for connecting to Syndetics for tables of contents.

AbstractBase::listsEnabled() — Method in class AbstractBase

Are lists enabled?

AbstractRecord::loadRecord() — Method in class AbstractRecord

Load the record requested by the user; note that this is not done in the init() method since we don't want to perform an expensive search twice when homeAction() forwards to another method.

AbstractRecord::loadTabDetails() — Method in class AbstractRecord

Support method to load tab information from the RecordTab PluginManager.

BrowseController::lccAction() — Method in class BrowseController

Browse LCC

$ ChannelsController#loaderProperty in class ChannelsController

Channel loader

$ CoverController#loaderProperty in class CoverController

Cover loader

EdsrecordController::linkedtextAction() — Method in class EdsrecordController

Linked text display action.

HoldsController::listAction() — Method in class HoldsController

Send list of holds to view

LibGuidesControllerClass in namespace VuFind\Controller

LibGuides Controller

LibraryCardsControllerClass in namespace VuFind\Controller

Controller for the library card functionality.

MyResearchController::loginAction() — Method in class MyResearchController

Login Action

MyResearchController::logoutAction() — Method in class MyResearchController

Logout Action

MyResearchController::listTagsEnabled() — Method in class MyResearchController

Are list tags enabled?

DbUpgrade::loadSql() — Method in class DbUpgrade

Given a SQL file, parse it for table creation commands.

$ Favorites#loaderProperty in class Favorites

Record loader

$ IlsRecords#loaderProperty in class IlsRecords

Record loader

$ QRCodeController#loaderProperty in class QRCodeController

QR Code loader

RelaisController::loginAction() — Method in class RelaisController

Relais login action

ShibbolethLogoutNotificationController::logoutNotification() — Method in class ShibbolethLogoutNotificationController

Logout notification handler

$ UpgradeController#logsqlProperty in class UpgradeController

Are we capturing SQL instead of executing it?

$ Generator#layerManagerProperty in class Generator

Layer manager

LayerInterfaceClass in namespace VuFind\Cover\Layer

Cover layer interface

LoaderClass in namespace VuFind\Cover

Book Cover Generator

$ Loader#localFileProperty in class Loader

Filename constructed from ISBN

Loader::loadImage() — Method in class Loader

Load an image given an ISBN and/or content type.

Loader::loadUnavailable() — Method in class Loader

{@inheritdoc} Adds self::$hasLoadedUnavailable flag

LoaderFactoryClass in namespace VuFind\Cover

Cover loader factory.

PrivateUser::libraryCardsEnabled() — Method in class PrivateUser

Whether library cards are enabled

$ Search#last_notification_sentProperty in class Search
$ User#lastnameProperty in class User
$ User#last_loginProperty in class User
$ User#last_languageProperty in class User
User::libraryCardsEnabled() — Method in class User

Whether library cards are enabled

OverdriveConnector::lockinResource() — Method in class OverdriveConnector

Lock In Overdrive Resource for a particular format

LibraryCardClass in namespace VuFind\Exception

Library Card Exception

ListPermissionClass in namespace VuFind\Exception

List Permission Exception

LoginRequiredClass in namespace VuFind\Exception

Login Required Exception

$ Feed#linksProperty in class Feed
Links
LocaleDetectorCookieStrategyClass in namespace VuFind\I18n\Locale

Locale Detector Strategy for language cookie

LocaleDetectorFactoryClass in namespace VuFind\I18n\Locale

Locale Detector Delegator Factory

LocaleDetectorParamStrategyClass in namespace VuFind\I18n\Locale

Locale Detector Strategy for VuFind POST Parameter

LocaleSettingsClass in namespace VuFind\I18n\Locale

VuFind Locale Settings

LanguageInitializerTraitClass in namespace VuFind\I18n\Translator

Logic for initializing a language within a translator used by VuFind.

$ ExtendedIni#loadedFilesProperty in class ExtendedIni

List of files loaded during the current run -- avoids infinite loops and duplicate loading.

ExtendedIni::load() — Method in class ExtendedIni

Load method defined by FileLoaderInterface.

ExtendedIni::loadLanguageLocale() — Method in class ExtendedIni

Load the language file for a given locale and domain.

ExtendedIni::loadLanguageFile() — Method in class ExtendedIni

Search the path stack for language files and merge them together.

ExtendedIni::loadParentData() — Method in class ExtendedIni

Support method for loadLanguageFile: retrieve parent data.

Connection::loginIsHidden() — Method in class Connection

Get Hidden Login Mode

$ Aleph#languagesProperty in class Aleph

ISO 3166-1 alpha-2 to ISO 3166-1 alpha-3 mapping for translation in REST DLF API.

DAIA::logMessages() — Method in class DAIA

Logs content of message elements in DAIA response for debugging

$ Demo#locationsProperty in class Demo

Item and pick up locations

$ Koha#locCodesProperty in class Koha

Location codes

$ KohaILSDI#locationsProperty in class KohaILSDI

Location codes

$ KohaILSDI#locationAuthorisedValuesCategoryProperty in class KohaILSDI

Authorised values category for location, defaults to 'LOC'

NoILS::loginIsHidden() — Method in class NoILS

Get Hidden Login Mode

Symphony::lookupTitleInfo() — Method in class Symphony

Look up title info

Symphony::libraryIsFilteredOut() — Method in class Symphony

Determine if a library is excluded by LibraryFilter configuration.

$ Voyager#lazyDbProperty in class Voyager

Lazily instantiated database connection. Use getDb() to access it.

XCNCIP2::loadPickUpLocations() — Method in class XCNCIP2

Load pickup locations from file or from NCIP responder - it depends on configuration

XCNCIP2::loadPickUpLocationsFromFile() — Method in class XCNCIP2

Loads pickup location information from configuration file.

XCNCIP2::loadPickUpLocationsFromNcip() — Method in class XCNCIP2

Loads pickup location information from LookupAgency NCIP service.

LogicFactoryClass in namespace VuFind\ILS\Logic

Shared factory for ILS logic classes.

ImageLoader::loadUnavailable() — Method in class ImageLoader

Load the user-specified "cover unavailable" graphic (or default if none specified).

ImageLoader::loadDefaultFailImage() — Method in class ImageLoader

Display the default "cover unavailable" graphic.

LoggerClass in namespace VuFind\Log

This class wraps the BaseLogger class to allow for log verbosity

Logger::log() — Method in class Logger

Add a message as a log entry

Logger::logException() — Method in class Logger

Log an exception triggered by the framework for administrative purposes.

LoggerAwareTraitClass in namespace VuFind\Log

Extension of \Laminas\Log\LoggerAwareTrait with some convenience methods.

LoggerAwareTrait::logError() — Method in class LoggerAwareTrait

Log an error message.

LoggerAwareTrait::logWarning() — Method in class LoggerAwareTrait

Log a warning message.

LoggerAwareTrait::log() — Method in class LoggerAwareTrait

Send a message to the logger.

LoggerFactoryClass in namespace VuFind\Log

Factory for instantiating Logger

Server::listMetadataFormats() — Method in class Server

Respond to a ListMetadataFormats request.

Server::listRecords() — Method in class Server

Respond to a ListIdentifiers or ListRecords request (the $verb parameter determines the exact format of the response).

Server::listSets() — Method in class Server

Respond to a ListSets request.

Server::listRecordsGetDeleted() — Method in class Server

Get an object containing the next page of deleted records from the specified date range.

Server::listRecordsGetDeletedCount() — Method in class Server

Get a count of all deleted records in the specified date range.

Server::listRecordsGetNonDeleted() — Method in class Server

Get an array of information on non-deleted records in the specified range.

Server::listRecordsGetParams() — Method in class Server

Get parameters for use in the listRecords method.

Server::listRecordsValidateDates() — Method in class Server

Validate the from and until parameters for the listRecords method.

Server::loadRecord() — Method in class Server

Load a specific record from the index.

Server::loadResumptionToken() — Method in class Server

Load parameters associated with a resumption token.

LoaderClass in namespace VuFind\QRCode

QR Code Generator

Loader::loadQRCode() — Method in class Loader

Set up a QR code image

LoaderFactoryClass in namespace VuFind\QRCode

Factory for QR Code Generator

AbstractFacets::loadBooleanConfigs() — Method in class AbstractFacets

Read boolean (OR/NOT) settings from the provided configuration

$ AbstractSummonRecommend#lookforProperty in class AbstractSummonRecommend

User query

$ AbstractSummonRecommendDeferred#lookforProperty in class AbstractSummonRecommendDeferred

Current search query

$ AuthorityRecommend#lookforProperty in class AuthorityRecommend

User search query

$ EDSResultsDeferred#lookforProperty in class EDSResultsDeferred

Current search query

$ EuropeanaResults#limitProperty in class EuropeanaResults

Result limit

$ EuropeanaResults#lookforProperty in class EuropeanaResults

Search string

$ EuropeanaResultsDeferred#lookforProperty in class EuropeanaResultsDeferred

Current search query

$ ExternalSearch#linkTextProperty in class ExternalSearch

Link text

$ ExternalSearch#lookforProperty in class ExternalSearch

Search query

Libraryh3lpClass in namespace VuFind\Recommend

Libraryh3lp Recommendations Module

$ OpenLibrarySubjects#limitProperty in class OpenLibrarySubjects

Search limit

$ RandomRecommend#limitProperty in class RandomRecommend

Results Limit

$ RecommendLinks#linksProperty in class RecommendLinks

Links to show

$ SearchObject#limitProperty in class SearchObject

Number of results to show

EDS::linkUrls() — Method in class EDS

Performs a regex and replaces any url's with links containing themselves as the text. Also replaces link elements with anchors.

$ MarcReaderTrait#lazyMarcReaderProperty in class MarcReaderTrait

MARC reader. Access only via getMarcReader() as this is initialized lazily.

LibGuidesClass in namespace VuFind\RecordDriver

Model for LibGuides records.

$ AbstractContent#loaderProperty in class AbstractContent

Content loader

$ CollectionHierarchyTree#loaderProperty in class CollectionHierarchyTree

Record loader

$ TabManager#legacyConfigProperty in class TabManager

Overall framework configuration (used for fetching configurations "the old way" -- can eventually be deprecated).

Cache::lookup() — Method in class Cache

Given a record ID, look up a record for that source.

Cache::lookupBatch() — Method in class Cache

Given an array of IDs and a record source, look up a batch of records for that source.

AbstractFallbackLoader::load() — Method in class AbstractFallbackLoader

Given an array of IDs that failed to load, try to find them using a fallback mechanism.

FallbackLoaderInterface::load() — Method in class FallbackLoaderInterface

Given an array of IDs that failed to load, try to find them using a fallback mechanism.

$ Solr#legacyIdFieldProperty in class Solr

Solr field containing legacy IDs.

LoaderClass in namespace VuFind\Record

Record loader

Loader::load() — Method in class Loader

Given an ID and record source, load the requested record object.

Loader::loadBatchForSource() — Method in class Loader

Given an array of IDs and a record source, load a batch of records for that source.

Loader::loadBatch() — Method in class Loader

Given an array of associative arrays with id and source keys (or pipe- separated source|id strings), load all of the requested records in the requested order.

LoaderFactoryClass in namespace VuFind\Record

Record loader factory.

$ CsvReader#loadedProperty in class CsvReader

Flag indicating whether or not we have processed data yet.

CsvReader::loadFile() — Method in class CsvReader

Load data from a single file.

CsvReader::load() — Method in class CsvReader

Load data if it is not already loaded.

$ Redi#linksProperty in class Redi

Parsed resolver links

$ BackendManager#listenersProperty in class BackendManager

Attached listeners.

$ FacetCache#languageProperty in class FacetCache

Currently selected language

$ Options#limitOptionsProperty in class Options

Available limit options

$ Options#listviewOptionProperty in class Options

Active list view option (see [List] in searches.ini).

Options::limitOrderOverride() — Method in class Options

Get advanced search limits that override the natural sorting to display at the top.

$ Params#limitProperty in class Params

Result limit

$ Params#lastViewProperty in class Params

Previously-used view (loaded in from session)

$ Options#limiterOptionsProperty in class Options

Available limiter options

$ AbstractSolrBackendFactory#loggerProperty in class AbstractSolrBackendFactory
Logger.
AbstractSolrBackendFactory::loadSpecs() — Method in class AbstractSolrBackendFactory

Load the search specs.

$ BrowZineBackendFactory#loggerProperty in class BrowZineBackendFactory
Logger.
$ EITBackendFactory#loggerProperty in class EITBackendFactory
Logger.
$ EdsBackendFactory#loggerProperty in class EdsBackendFactory
Logger.
LibGuidesBackendFactoryClass in namespace VuFind\Search\Factory

Factory for LibGuides backends.

$ LibGuidesBackendFactory#loggerProperty in class LibGuidesBackendFactory
Logger.
$ LibGuidesBackendFactory#libGuidesConfigProperty in class LibGuidesBackendFactory

LibGuides configuration

$ Pazpar2BackendFactory#loggerProperty in class Pazpar2BackendFactory
Logger.
$ PrimoBackendFactory#loggerProperty in class PrimoBackendFactory
Logger.
$ SummonBackendFactory#loggerProperty in class SummonBackendFactory
Logger.
$ WorldCatBackendFactory#loggerProperty in class WorldCatBackendFactory
Logger.
$ Results#listProperty in class Results

Active user list (false if none).

$ Results#listTableProperty in class Results

UserList table

AbstractErrorListener::listenForBackend() — Method in class AbstractErrorListener

Return true if listeners listens for backend errors.

LowerCaseServiceNameTraitClass in namespace VuFind\ServiceManager

Trait for plugin managers that allows service names to be normalized to lowercase (for backward compatibility with ServiceManager v2).

$ AbstractBase#lifetimeProperty in class AbstractBase

Session lifetime in seconds

$ Generator#languagesProperty in class Generator

Languages enabled for sitemaps

$ SitemapIndex#lastmodProperty in class SitemapIndex

Last modification date of sitemaps.

LayoutClassClass in namespace VuFind\View\Helper\Bootstrap3

Helper class for managing bootstrap theme's high-level (body vs. sidebar) page layout.

LayoutClassFactoryClass in namespace VuFind\View\Helper\Bootstrap3

LayoutClass helper factory.

$ ContentLoader#loaderProperty in class ContentLoader

Content loader

LinkifyClass in namespace VuFind\View\Helper\Root

Linkify a string so that the links become clickable HTML

LinkifyFactoryClass in namespace VuFind\View\Helper\Root

Linkify helper factory

LocalizedNumberClass in namespace VuFind\View\Helper\Root

Class NumberFormat allows localization based formating of numbers in view

$ Piwik#lightboxProperty in class Piwik

Whether the tracker was initialized from lightbox.

$ Relais#loginUrlProperty in class Relais

Login URL

UserList::lastUsed() — Method in class UserList

Retrieve the ID of the last list that was accessed, if any.

$ UserTags#listModeProperty in class UserTags

List tag mode (enabled or disabled)

$ VuFindGeo#logMethodProperty in class VuFindGeo

Method for logging errors (overrideable for testing purposes)

VuFindGeo::logError() — Method in class VuFindGeo

Log an error message

M

$ Search2ApiController#modelPrefixProperty in class Search2ApiController

Prefix for use in model names used by API

ModuleClass in namespace KnihovnyCzApi

Template for code module for storing local overrides.

ModuleClass in namespace KnihovnyCzConsole

Module for console commands

ModuleClass in namespace KnihovnyCzCronApi

Class Module

MultiBackendTestClass in namespace KnihovnyCzTest\ILS\Driver

Class MutiBackendTest

GetLibrariesACSuggestions::mungeQuery() — Method in class GetLibrariesACSuggestions

Process the user query to make it suitable for a Solr query.

ManagerClass in namespace KnihovnyCz\Auth

Wrapper class for handling logged-in user in session.

ManagerFactoryClass in namespace KnihovnyCz\Auth

Authentication Manager factory.

SolrPrefixSorted::mungeQuery() — Method in class SolrPrefixSorted

Process the user query to make it suitable for a Solr query.

CartController::myresearchbulkAction() — Method in class CartController

Process bulk actions from the MyResearch area; most of this is only necessary when Javascript is disabled.

MyResearchControllerClass in namespace KnihovnyCz\Controller

Class MyResearchController

MyResearchController::mylistAction() — Method in class MyResearchController

Send user's saved favorites from a particular list to the view

MyResearchTraitClass in namespace KnihovnyCz\Controller

Class MyResearchTrait

MyResearchZiskejEddControllerClass in namespace KnihovnyCz\Controller

Class MyResearchZiskejEddController

MyResearchZiskejMvsControllerClass in namespace KnihovnyCz\Controller

Class MyResearchZiskejController

$ User#majorProperty in class User
$ UserCard#majorProperty in class UserCard
User::merge() — Method in class User

This method basically replaces all occurrences of $from->id (UserRow id) in tables comments, user_resource, user_list, user_card and search with $into->id in user_id column.

KohaRest1905::makeRequest() — Method in class KohaRest1905

Make Request

MultiBackendClass in namespace KnihovnyCz\ILS\Driver

Class MultiBackend

MultiBackendFactoryClass in namespace KnihovnyCz\ILS\Driver

Factory for MultiBackend ILS driver.

MultiConnectionClass in namespace KnihovnyCz\ILS

Catalog Connection Class

MultiConnectionFactoryClass in namespace KnihovnyCz\ILS

Catalog Connection Class

ModuleClass in namespace KnihovnyCz

Template for ZF2 module for storing local overrides.

MapSelectionClass in namespace KnihovnyCz\Recommend

Class MapSelection

$ MapSelection#mapScaleFieldProperty in class MapSelection

The solr field used for searching by scale

MapSelectionFactoryClass in namespace KnihovnyCz\Recommend

Class MapSelectionFactory

MultiplyingDeduplicationListenerClass in namespace KnihovnyCz\Search\Solr

Solr merged record handling listener.

$ UserSettingsService#memoryProperty in class UserSettingsService
Memory
$ DatabaseCsrf#messagesProperty in class DatabaseCsrf

Validation messages

$ SearchTabs#memoryProperty in class SearchTabs

Search Memory

MaintenanceControllerClass in namespace VuFindAdmin\Controller

Class helps maintain database

TagsController::manageAction() — Method in class TagsController

Manage Tags

ModuleClass in namespace VuFindAdmin

VuFind Admin Tools module.

$ Search2ApiController#modelPrefixProperty in class Search2ApiController

Prefix for use in model names used by API

$ SearchApiController#modelPrefixProperty in class SearchApiController

Prefix for use in model names used by API

$ SearchApiController#maxLimitProperty in class SearchApiController

Max limit of search results in API response (default 100);

$ WebApiController#modelPrefixProperty in class WebApiController

Prefix for use in model names used by API

FacetFormatter::matchFacetItem() — Method in class FacetFormatter

Match a facet item with the filters.

ModuleClass in namespace VuFindApi

VuFind Api module.

$ NonTabRecordActionCommand#mainConfigProperty in class NonTabRecordActionCommand

Main framework configuration

MergeMarcCommandClass in namespace VuFindConsole\Command\Harvest

Console command: Merge MARC records.

$ InstallCommand#moduleProperty in class InstallCommand

Custom local code module name (if any).

$ InstallCommand#multisiteModeProperty in class InstallCommand

Active multi-site mode.

$ NotifyCommand#mainConfigProperty in class NotifyCommand

Top-level VuFind configuration

$ NotifyCommand#mailerProperty in class NotifyCommand

Mail service

NotifyCommand::msg() — Method in class NotifyCommand

Display a message.

$ AbstractExpireCommand#minAgeProperty in class AbstractExpireCommand

Minimum legal age (in days) of rows to delete.

$ ExpireSessionsCommand#minAgeProperty in class ExpireSessionsCommand

Minimum legal age of rows to delete.

ModuleClass in namespace VuFindConsole

Code module for VuFind's console functionality

ModuleClass in namespace VuFindDevTools

VuFind Developer Tools module.

ModuleClass in namespace VuFindLocalTemplate

Template for code module for storing local overrides.

$ Backend#mappingsProperty in class Backend

Mappings configuration

$ RecordCollection#mappingsProperty in class RecordCollection

Mappings configuration

RecordCollection::mapFacetValues() — Method in class RecordCollection

Map facet values from the backends into a merged list

$ Backend#maxQueryTimeProperty in class Backend

The maximum amount of time to wait to reach $progressTarget (above) before giving up and accepting what is currently available. (Measured in seconds).

$ Connector#mapProperty in class Connector

Handler map.

$ RawDocument#mimeProperty in class RawDocument

MIME type

Spellcheck::mergeWith() — Method in class Spellcheck

Merge in other spellcheck information.

SearchHandler::mungeValues() — Method in class SearchHandler

Return the munge values for specified search string.

SearchHandler::mungeRules() — Method in class SearchHandler

Return array of munge rules.

SearchHandler::munge() — Method in class SearchHandler

Return modified search string after applying the transformation rules.

$ Record#marcProperty in class Record

MARC record.

$ CallMethodCommand#methodProperty in class CallMethodCommand

Search backend interface method

ModuleClass in namespace VuFindSearch

Code module containing the VuFind search service.

ParamBag::mergeWith() — Method in class ParamBag

Merge with another parameter bag.

ParamBag::mergeWithAll() — Method in class ParamBag

Merge with all supplied parameter bags.

ManagerTestClass in namespace VuFindTest\Auth

Authentication manager test class.

MultiAuthTestClass in namespace VuFindTest\Auth

LDAP authentication test class.

MultiILSTestClass in namespace VuFindTest\Auth

MultiILS authentication test class.

$ BackendTest#mappingsProperty in class BackendTest
Mappings
MergeMarcCommandTestClass in namespace VuFindTest\Command\Harvest

MergeMarc command test.

MockConfigPluginManagerClass in namespace VuFindTest\Container

VuFind config plugin container that produces mock objects.

MockContainerClass in namespace VuFindTest\Container

Container that produces mock objects.

MockContainerTraitClass in namespace VuFindTest\Container

Trait for implementing containers that produces mock objects.

$ MockContainerTrait#mockServicesProperty in class MockContainerTrait
Services
$ MockContainerTrait#mockAliasesProperty in class MockContainerTrait

Common service aliases.

MockDbTablePluginManagerClass in namespace VuFindTest\Container

DB table plugin container that produces mock objects.

MockViewHelperContainerClass in namespace VuFindTest\Container

View helper container that produces mock objects.

InstallControllerTest::mockControllerWithComposerJson() — Method in class InstallControllerTest

Mock controller

MockILSConnectionClass in namespace VuFindTest\Controller\Plugin
MockLoaderClass in namespace VuFindTest\Cover
CssPreCompilerTest::makeFakeThemeStructure() — Method in class CssPreCompilerTest

Create fixture files in temp folder

MockSearchCommandTraitClass in namespace VuFindTest\Feature

Trait for tests requiring mock search Command objects

$ FormTest#mockTestFormYamlReaderProperty in class FormTest
AlephTest::mockResponse() — Method in class AlephTest

Mock fixture as HTTP client response

FolioTest::mockMakeRequest() — Method in class FolioTest

Replace makeRequest to inject test returns

MultiBackendTestClass in namespace VuFindTest\ILS\Driver

ILS driver test

XCNCIP2Test::mockResponse() — Method in class XCNCIP2Test

Mock fixture as HTTP client response

OAuth2TokenTraitTest::mockResponse() — Method in class OAuth2TokenTraitTest

Mock fixture as HTTP client response

MinkTestCaseClass in namespace VuFindTest\Integration

Abstract base class for PHPUnit test cases using Mink.

$ MinkTestCase#modifiedConfigsProperty in class MinkTestCase

Modified configurations

$ MinkTestCase#modifiedYamlConfigsProperty in class MinkTestCase

Modified yaml configurations

MailerTestClass in namespace VuFindTest\Mailer

Mailer Test Class

MockEmailRendererClass in namespace VuFindTest\Mailer
RecordActionsTest::makeAccount() — Method in class RecordActionsTest

Make new account

MapSelectionTestClass in namespace VuFindTest\Recommend

MapSelection recommendation module Test Class

MarcAdvancedTraitTestClass in namespace VuFindTest\RecordDriver\Feature

Record Driver Marc Advanced Trait Test Class

MarcBasicTraitTestClass in namespace VuFindTest\RecordDriver\Feature

Record Driver Marc Traits Test Class

MapTestClass in namespace VuFindTest\RecordTab

Map Test Class

$ ParamsTest#mappingsProperty in class ParamsTest
Mappings
MemoryTestClass in namespace VuFindTest\Search

Memory unit tests.

MultiIndexListenerTestClass in namespace VuFindTest\Search\Solr

Unit tests for multiindex listener.

MarkdownFactoryTestClass in namespace VuFindTest\Service

MarkdownFactory Test Class

MemcacheTestClass in namespace VuFindTest\Session

Memcache Session Handler Test Class

$ StartPageTest#messagesProperty in class StartPageTest

Messages collected

MakeLinkTestClass in namespace VuFindTest\View\Helper\Root

makeLink view helper Test Class

MakeTagTestClass in namespace VuFindTest\View\Helper\Root

makeTag view helper Test Class

MarkdownTestClass in namespace VuFindTest\View\Helper\Root

MArkdown Test Class

MetadataTestClass in namespace VuFindTest\View\Helper\Root

Metadata Test Class

$ VuFindGeoTest#messagesProperty in class VuFindGeoTest
AbstractCssPreCompiler::makeRelative() — Method in class AbstractCssPreCompiler

Convert fake absolute paths to working relative paths.

$ Initializer#mobileProperty in class Initializer

Mobile interface detector

MixinGeneratorClass in namespace VuFindTheme

Class to generate a new mixin from a template.

MobileClass in namespace VuFindTheme

Mobile Device Detection Wrapper

ModuleClass in namespace VuFindTheme

Module definition for the VuFind theme system.

ThemeCompiler::mergeConfig() — Method in class ThemeCompiler

Merge configurations from $src into $dest; return the result.

$ HeadLink#maxImportSizeProperty in class HeadLink

Maximum import size (for inlining of e.g. images) in kilobytes

$ DoiLookup#multiModeProperty in class DoiLookup

Behavior to use when multiple resolvers find results for the same DOI (may be 'first' -- use first match, or 'merge' -- use all results)

$ ChoiceAuth#managerProperty in class ChoiceAuth

Plugin manager for obtaining other authentication objects

$ EmailAuthenticator#mailerProperty in class EmailAuthenticator
Mailer
ManagerClass in namespace VuFind\Auth

Wrapper class for handling logged-in user in session.

Manager::makeAuth() — Method in class Manager
Helper
ManagerFactoryClass in namespace VuFind\Auth

Authentication Manager factory.

MultiAuthClass in namespace VuFind\Auth

MultiAuth Authentication plugin

$ MultiAuth#methodsProperty in class MultiAuth

Authentication methods to try

$ MultiAuth#managerProperty in class MultiAuth

Plugin manager for obtaining other authentication objects

MultiAuthFactoryClass in namespace VuFind\Auth

Factory for MultiAuth authentication module.

MultiILSClass in namespace VuFind\Auth

Multiple ILS authentication module that works with MultiBackend driver

MultiIdPConfigurationLoaderClass in namespace VuFind\Auth\Shibboleth

Configuration loader for Multiple IdPs

Solr::mungeQuery() — Method in class Solr

Process the user query to make it suitable for a Solr query.

Solr::matchQueryTerms() — Method in class Solr

Return true if all terms in the query occurs in the field data string.

SolrCN::mungeQuery() — Method in class SolrCN

Process the user query to make it suitable for a Solr query.

SolrPrefix::mungeQuery() — Method in class SolrPrefix

Process the user query to make it suitable for a Solr query.

ManagerClass in namespace VuFind\Cache

VuFind Cache Manager

ManagerFactoryClass in namespace VuFind\Cache

Cache Manager factory.

$ Cart#maxSizeProperty in class Cart

Maximum number of items allowed in cart.

$ AbstractILSChannelProvider#maxAgeProperty in class AbstractILSChannelProvider

Maximum age (in days) of results to retrieve.

$ AlphaBrowse#maxRecordsToExamineProperty in class AlphaBrowse

Maximum number of records to examine for similar results.

$ Facets#maxFieldsToSuggestProperty in class Facets

Maximum number of different fields to suggest in the channel list.

$ Facets#maxValuesToSuggestPerFieldProperty in class Facets

Maximum number of values to suggest per field.

$ Random#modeProperty in class Random
Mode
$ SimilarItems#maxRecordsToExamineProperty in class SimilarItems

Maximum number of records to examine for similar results.

$ AbstractCover#mandatoryBacklinkLocationsProperty in class AbstractCover

Are backlinks to source of cover mandatory?

CartController::myresearchbulkAction() — Method in class CartController

Process bulk actions from the MyResearch area; most of this is only necessary when Javascript is disabled.

MissingrecordControllerClass in namespace VuFind\Controller

Missing Record Controller

MyResearchControllerClass in namespace VuFind\Controller

Controller for the user account area.

MyResearchController::mylistAction() — Method in class MyResearchController

Send user's saved favorites from a particular list to the view

OverdriveController::mycontentAction() — Method in class OverdriveController

My Content Action Prepares the view for the Overdrive MyContent template.

$ Container#managerProperty in class Container

Cookie manager.

$ User#majorProperty in class User
ChangeTracker::markDeleted() — Method in class ChangeTracker

Update the change tracker table to indicate that a record has been deleted.

Tags::matchText() — Method in class Tags

Get the tags that match a string

Tags::mergeTags() — Method in class Tags

Support method for fixDuplicateTag() -- merge $source into $target.

$ OverdriveConnector#mainConfigProperty in class OverdriveConnector

Record Config

MailClass in namespace VuFind\Exception

Mail Exception

MissingFieldClass in namespace VuFind\Exception

Missing Field Exception

$ Export#mainConfigProperty in class Export

Main VuFind configuration

$ Form#messagesProperty in class Form

Default, untranslated validation messages

Form::mapRequestParamsToFieldValues() — Method in class Form

Map request parameters to field values

Form::mergeLocalConfig() — Method in class Form

Merge local configuration into default configuration.

$ Email#mainConfigProperty in class Email

Main config

$ Email#mailerProperty in class Email
Mailer
MapSelectionConfigClass in namespace VuFind\GeoFeatures

MapSelection Configuration Class

MapTabConfigClass in namespace VuFind\GeoFeatures

MapTab Configuration Class

Json::mapChildren() — Method in class Json

Get Solr Children for JSON

Xml::mapChildren() — Method in class Xml

Get Solr Children for JSON

LocaleSettings::markLocaleInitialized() — Method in class LocaleSettings

Mark a locale as initialized.

AbstractAPI::makeRequest() — Method in class AbstractAPI

Make requests

Alma::makeRequest() — Method in class Alma

Make an HTTP request against Alma

$ DAIA#multiQueryProperty in class DAIA

Flag to enable multiple DAIA-queries

HorizonXMLAPI::makeRequest() — Method in class HorizonXMLAPI

Make Request

KohaILSDI::makeRequest() — Method in class KohaILSDI

Make Request

KohaILSDI::makeIlsdiRequest() — Method in class KohaILSDI

Make Ilsdi Request Array

KohaRest::makeRequest() — Method in class KohaRest

Make Request

KohaRest::mapRenewalBlockReason() — Method in class KohaRest

Map a Koha renewal block reason code to a VuFind translation string

MultiBackendClass in namespace VuFind\ILS\Driver

Multiple Backend Driver.

$ MultiBackend#methodsWithNoSourceSpecificParametersProperty in class MultiBackend

Methods that don't have parameters that allow the correct source to be determined. These methods are only supported for the default driver.

MultiBackendFactoryClass in namespace VuFind\ILS\Driver

Factory for MultiBackend ILS driver.

PAIA::mapPaiaItems() — Method in class PAIA

PAIA helper function to allow customization of mapping from PAIA response to VuFind ILS-method return values.

PAIA::myHoldsMapping() — Method in class PAIA

This PAIA helper function allows custom overrides for mapping of PAIA response to getMyHolds data structure.

PAIA::myStorageRetrievalRequestsMapping() — Method in class PAIA

This PAIA helper function allows custom overrides for mapping of PAIA response to getMyStorageRetrievalRequests data structure.

PAIA::myTransactionsMapping() — Method in class PAIA

This PAIA helper function allows custom overrides for mapping of PAIA response to getMyTransactions data structure.

Polaris::makeRequest() — Method in class Polaris

Make Request

SierraRest::makeRequest() — Method in class SierraRest

Make Request

SierraRest::mapStatusCode() — Method in class SierraRest

Get the human-readable equivalent of a status code.

Symphony::makeRequest() — Method in class Symphony

Make a request to Symphony Web Services using the SOAP protocol.

Unicorn::mapLocation() — Method in class Unicorn

Map the location code to friendly name.

Unicorn::mapLibrary() — Method in class Unicorn

Maps the library code to friendly library name.

VoyagerRestful::makeRequest() — Method in class VoyagerRestful

Make Request

VoyagerRestful::makeItemRequests() — Method in class VoyagerRestful

Make Item Requests

$ XCNCIP2#maxNumberOfPagesProperty in class XCNCIP2

Max number of pages taken from API at once. Sometimes NCIP responders could paginate even if we want all data at one time. We then ask for all pages, but it could possibly lead to long response times.

MailClass in namespace VuFind\Log\Writer

This class extends the Laminas Logging towards Mail systems

$ Slack#messageIconsProperty in class Slack

Icons that appear at the start of log messages in Slack, by severity

MailerClass in namespace VuFind\Mailer

VuFind Mailer Class

$ Mailer#maxRecipientsProperty in class Mailer

The maximum number of email recipients allowed (0 = no limit)

MetadataVocabularyInterfaceClass in namespace VuFind\MetadataVocabulary

Metadata vocabulary interface

ModuleClass in namespace VuFind

Code module for the core of the VuFind application

$ Server#metadataFormatsProperty in class Server

Supported metadata formats

Loader::mapErrorLevel() — Method in class Loader

Map an incoming error correction level parameter to a valid constant.

$ AbstractSummonRecommendDeferred#moduleProperty in class AbstractSummonRecommendDeferred

Name of module being loaded by AJAX -- MUST be set in constructor!

$ AuthorityRecommend#modeProperty in class AuthorityRecommend

Which lookup mode(s) to use.

$ DOI#matchProperty in class DOI

DOI found in search query (or null for none)

MapSelectionClass in namespace VuFind\Recommend

MapSelection Recommendations Module

MapSelectionFactoryClass in namespace VuFind\Recommend

MapSelection recommendation module factory.

$ RandomRecommend#modeProperty in class RandomRecommend
Mode
$ RandomRecommend#minimumProperty in class RandomRecommend

Result Set Minimum

$ SideFacets#mainFacetsProperty in class SideFacets

Main facet configuration

$ AbstractBase#mainConfigProperty in class AbstractBase

Main VuFind configuration

MarcAdvancedTraitClass in namespace VuFind\RecordDriver\Feature

Functions to add advanced MARC-driven functionality to a record driver already powered by the standard index spec. Depends upon MarcReaderTrait.

MarcBasicTraitClass in namespace VuFind\RecordDriver\Feature

Functions to add basic MARC-driven functionality to a record driver not already powered by the standard index spec. Depends upon MarcReaderTrait.

MarcReaderTraitClass in namespace VuFind\RecordDriver\Feature

Functions for reading MARC records.

$ MarcReaderTrait#marcReaderClassProperty in class MarcReaderTrait

MARC reader class to use.

MissingClass in namespace VuFind\RecordDriver

Model for missing records -- used for saved favorites that have been deleted from the index.

$ ComponentParts#maxResultsProperty in class ComponentParts

Maximum results to display

MapClass in namespace VuFind\RecordTab

Map tab

$ Map#mapTabDisplayProperty in class Map

Should Map Tab be displayed?

$ Map#mapLabelsProperty in class Map

Map labels setting from config.ini.

MapFactoryClass in namespace VuFind\RecordTab

Factory for building the Map tab.

Alma::mapServiceType() — Method in class Alma

Map Alma service types to VuFind. Returns an empty string for an unmapped value.

$ DynamicRoleProvider#managerProperty in class DynamicRoleProvider

Permission provider manager

MailerClass in namespace VuFind\SMS

VuFind Mailer Class for SMS messages

$ Mailer#mailerProperty in class Mailer

VuFind Mailer object

$ Options#mainIniProperty in class Options

Configuration file to read global settings from

$ Params#mappingsProperty in class Params

Blender mappings

$ Options#modeOptionsProperty in class Options

Available search mode options

Options::mapSortLabel() — Method in class Options

Map EBSCO sort labels to standard VuFind text.

$ AbstractSolrBackendFactory#mainConfigProperty in class AbstractSolrBackendFactory

Primary configuration file identifier.

$ BlenderBackendFactory#mappingsConfigProperty in class BlenderBackendFactory

Mappings YAML configuration file identifier.

MemoryClass in namespace VuFind\Search

Wrapper class to handle search memory

MemoryFactoryClass in namespace VuFind\Search

Search memory factory.

MinifiedClass in namespace VuFind\Search

A minified search object used exclusively for trimming a search object down to its barest minimum size before storage in a cookie or database.

$ NormalizedSearch#minifiedProperty in class NormalizedSearch

Minified version of search

QueryAdapter::minify() — Method in class QueryAdapter

Convert a Query or QueryGroup into minified search arguments.

$ FilterFieldConversionListener#mapProperty in class FilterFieldConversionListener

Map of old field => new field.

MultiIndexListenerClass in namespace VuFind\Search\Solr

MultiIndex listener class file.

$ Options#maxTopicRecommendationsProperty in class Options

Maximum number of topic recommendations to show (false for none)

MarkdownFactoryClass in namespace VuFind\Service

VuFind Markdown Service factory.

ManagerFactoryClass in namespace VuFind\Session

Factory for instantiating Session Manager

MemcacheClass in namespace VuFind\Session

Memcache session handler

$ Settings#managerProperty in class Settings

Session manager (if instantiated)

$ Tags#maxLengthProperty in class Tags

Maximum tag length.

$ Database#maxHashLengthProperty in class Database

The maximum allowed hash length (tied to the width of the database hash column); if we can't generate a unique hash under this length, something has gone very wrong.

AbstractJsStrings::mapValue() — Method in class AbstractJsStrings

Transform strings before JSON encoding

$ Auth#managerProperty in class Auth

Authentication manager

Icon::mapIcon() — Method in class Icon

Map icon to set. Add prefix, return with set and template.

JsIcons::mapValue() — Method in class JsIcons

Generate Icon from string

JsTranslations::mapValue() — Method in class JsTranslations

Translate string

MakeLinkClass in namespace VuFind\View\Helper\Root

Make link view helper

MakeLink::mergeAttributes() — Method in class MakeLink

Combine attributes including proxy

MakeTagClass in namespace VuFind\View\Helper\Root

Make tag view helper

MarkdownClass in namespace VuFind\View\Helper\Root

Helper for transforming markdown to html

MarkdownFactoryClass in namespace VuFind\View\Helper\Root

Markdown helper factory

MatomoClass in namespace VuFind\View\Helper\Root

Matomo web analytics view helper for Matomo versions >= 4

MatomoFactoryClass in namespace VuFind\View\Helper\Root

Matomo helper factory.

MetadataClass in namespace VuFind\View\Helper\Root

Metadata view helper

$ Metadata#metaHelperProperty in class Metadata

Laminas meta helper, used to embed html tags in the generated page

MetadataFactoryClass in namespace VuFind\View\Helper\Root

Metadata helper factory

$ SpecBuilder#maxPosProperty in class SpecBuilder

Highest position value so far.

$ SearchMemory#memoryProperty in class SearchMemory

Search memory

$ SearchOptions#managerProperty in class SearchOptions

Search manager

$ SearchParams#managerProperty in class SearchParams

Search manager

$ UserList#modeProperty in class UserList

List mode (enabled or disabled)

$ UserTags#modeProperty in class UserTags

Tag mode (enabled or disabled)

VuFind::mapString() — Method in class VuFind

Map string using a config file from the translation_maps folder.

minSOClass in namespace [Global Namespace]

This non-namespaced class exists to keep serialized search objects small by using an abbreviated name. Unfortunately, the name does not comply with coding standards, but we cannot easily change it due to legacy compatibility issues.

N

$ XCNCIP2Test#notRenewableTransactionsTestsProperty in class XCNCIP2Test
SuggestionFilter::normalize() — Method in class SuggestionFilter

Normalize query

Parser::normalizeRange() — Method in class Parser

Normalize range - return min and max value from range.

KohaRest1905::normalizeDate() — Method in class KohaRest1905

Get date in display format

NoILSClass in namespace KnihovnyCz\ILS\Driver

Class NoILS

$ XCNCIP2#notHoldableStatusesProperty in class XCNCIP2

Lowercased circulation statuses we consider not be holdable

$ JsonFacetListener#nestedFacetsProperty in class JsonFacetListener

Nested facets

NullSessionManagerClass in namespace KnihovnyCz\Session

Class PerRequestSessionManager

NonTabRecordActionCommandClass in namespace VuFindConsole\Command\Generate

Console command: Generate non-tab record action route.

NonTabRecordActionCommandFactoryClass in namespace VuFindConsole\Command\Generate

Factory for non-tab record action route generator command.

$ AbstractCommand#normalizerProperty in class AbstractCommand

Normalizer for .ini files

NormalizeCommandClass in namespace VuFindConsole\Command\Language

Language command: normalize file or directory.

NotifyCommandClass in namespace VuFindConsole\Command\ScheduledSearch

Console command: notify users of scheduled searches.

NotifyCommandFactoryClass in namespace VuFindConsole\Command\ScheduledSearch

Factory for ScheduledSearch/Notify command.

LuceneSyntaxHelper::normalizeSearchString() — Method in class LuceneSyntaxHelper

Return normalized input string.

LuceneSyntaxHelper::normalizeFancyQuotes() — Method in class LuceneSyntaxHelper

Normalize fancy quotes in a query.

LuceneSyntaxHelper::normalizeWildcards() — Method in class LuceneSyntaxHelper

Normalize wildcards in a query.

LuceneSyntaxHelper::normalizeParens() — Method in class LuceneSyntaxHelper

Normalize parentheses in a query.

LuceneSyntaxHelper::normalizeBoosts() — Method in class LuceneSyntaxHelper

Normalize boosts in a query.

LuceneSyntaxHelper::normalizeBracesAndBrackets() — Method in class LuceneSyntaxHelper

Normalize braces/brackets in a query.

LuceneSyntaxHelper::normalizeUnquotedText() — Method in class LuceneSyntaxHelper

Normalize various problems found in unquoted text within the query.

LuceneSyntaxHelper::normalizeColons() — Method in class LuceneSyntaxHelper

Normalize field specifications within the query.

NamedListClass in namespace VuFindSearch\Backend\Solr\Response\Json

SOLR NamedList with parameter json.nl=arrarr.

NamedList::next() — Method in class NamedList

Move to next element.

$ QueryGroup#negationProperty in class QueryGroup

Is the query group negated?

AbstractRecordCollection::next() — Method in class AbstractRecordCollection

Move to next collection index.

NamedListTestClass in namespace VuFindTest\Backend\Solr\Json\Response

Unit tests for SOLR NamedList.

NonTabRecordActionCommandTestClass in namespace VuFindTest\Command\Generate

Generate/NonTabRecordAction command test.

NormalizeCommandTestClass in namespace VuFindTest\Command\Language

Language/Normalize command test.

NotifyCommandTestClass in namespace VuFindTest\Command\ScheduledSearch

ScheduledSearch/Notify command test.

NewItemsTestClass in namespace VuFindTest\Controller\Plugin

New items controller plugin tests.

SorterTest::natsortProvider() — Method in class SorterTest
NewGenLibTestClass in namespace VuFindTest\ILS\Driver

ILS driver test

NoILSTestClass in namespace VuFindTest\ILS\Driver

ILS driver test

$ XCNCIP2Test#notRenewableTransactionsTestsProperty in class XCNCIP2Test
NextPrevNavTestClass in namespace VuFindTest\Mink

Next/previous navigation test class.

SwitchTypeTest::newHandlerNameProvider() — Method in class SwitchTypeTest

Data provider for testGetNewHandlerName.

SwitchTypeTest::newHandlerProvider() — Method in class SwitchTypeTest

Data provider for testGetNewHandler.

NormalizedSearchTestClass in namespace VuFindTest\Search

NormalizedSearch unit tests.

NoneTestClass in namespace VuFindTest\UrlShortener

"None" URL shortener test.

VuFindTest::nameProvider() — Method in class VuFindTest

DataProvider for name-related tests

PathConverter::normalize() — Method in class PathConverter

Normalize path.

AbstractBase::needsCsrfCheck() — Method in class AbstractBase

Whether this authentication method needs CSRF checking for the request.

ChoiceAuth::needsCsrfCheck() — Method in class ChoiceAuth

Whether this authentication method needs CSRF checking for the request.

Email::needsCsrfCheck() — Method in class Email

Whether this authentication method needs CSRF checking for the request.

ILSAuthenticator::newCatalogLogin() — Method in class ILSAuthenticator

Attempt to log in the user to the ILS, and save credentials if it works.

NoneClass in namespace VuFind\Autocomplete

No Autocomplete Module

NewILSItemsClass in namespace VuFind\ChannelProvider

"New ILS items" channel provider.

$ Upgrade#newDirProperty in class Upgrade

Directory where new configurations should be written (null for test mode)

$ Upgrade#newConfigsProperty in class Upgrade

Processed new configurations

OpenLibrary::normaliseSubjectString() — Method in class OpenLibrary

Support function to return a normalised version of the search string for use in the API url

AbstractBase::normalizeUrlForComparison() — Method in class AbstractBase

Normalize the referer URL so that inconsistencies in protocol and trailing slashes do not break comparisons.

AbstractBase::newItems() — Method in class AbstractBase

NewItems plugin

CollectionsController::normalizeAndSortFacets() — Method in class CollectionsController

Function to normalize the names so they sort properly

CollectionsController::normalizeForBrowse() — Method in class CollectionsController

Normalize the value for the browse sort

MyResearchController::newPasswordAction() — Method in class MyResearchController

Handling submission of a new password for a user.

DbUpgrade::normalizeConstraints() — Method in class DbUpgrade

Normalize constraint values.

DbUpgrade::nullableMatches() — Method in class DbUpgrade

Given a current row default, return true if the current nullability matches the one found in the SQL provided as the $sql parameter. Return false if there is a mismatch that will require table structure updates.

NewItemsClass in namespace VuFind\Controller\Plugin

Action helper to perform new items-related actions

NewItemsFactoryClass in namespace VuFind\Controller\Plugin

Factory for NewItems controller plugin.

SearchController::newitemAction() — Method in class SearchController

New item search form

SearchController::newitemresultsAction() — Method in class SearchController

New item result list

$ Loader#nbnProperty in class Loader

User National bibliography number parameter

$ Search#notification_frequencyProperty in class Search
$ Search#notification_base_urlProperty in class Search
Search::normalizeSearchObject() — Method in class Search

Support method to make sure that the search_object field is formatted as a string, since PostgreSQL sometimes represents it as a resource.

Export::needsRedirect() — Method in class Export

Does the requested format require a redirect?

ExtendedIniNormalizer::normalizeDirectory() — Method in class ExtendedIniNormalizer

Normalize a directory on disk.

ExtendedIniNormalizer::normalizeFile() — Method in class ExtendedIniNormalizer

Normalize a file on disk.

ExtendedIniNormalizer::normalizeFileToString() — Method in class ExtendedIniNormalizer

Normalize a file from disk and returns the result as a string.

Sorter::natsort() — Method in class Sorter

Natural sort by values and maintain index association

SorterInterface::natsort() — Method in class SorterInterface

Natural sort by values and maintain index association

NewGenLibClass in namespace VuFind\ILS\Driver

ILS Driver for NewGenLib

NoILSClass in namespace VuFind\ILS\Driver

Driver for offline/missing ILS.

NoILSFactoryClass in namespace VuFind\ILS\Driver

Factory for NoILS ILS driver.

$ XCNCIP2#notHoldableRestrictionProperty in class XCNCIP2

Lowercased item use restriction types we consider to be holdable

$ XCNCIP2#notHoldableStatusesProperty in class XCNCIP2

Lowercased circulation statuses we consider not be holdable

IpAddressUtils::normalizeIp() — Method in class IpAddressUtils

Normalize an IP address or a beginning of it to an IPv6 address

Server::normalizeDate() — Method in class Server

Normalize a date to a Unix timestamp.

AuthorInfo::normalizeName() — Method in class AuthorInfo

Normalize an author name using internal logic.

AuthorInfo::normalizeNameWithViaf() — Method in class AuthorInfo

Normalize an author name using VIAF.

$ SideFacets#numericRangeFacetsProperty in class SideFacets

Numeric range facet configuration

$ SwitchType#newHandlerProperty in class SwitchType

Search handler to try

$ SwitchType#newHandlerNameProperty in class SwitchType

On-screen description of handler

NameBasedConfigFactoryClass in namespace VuFind\RecordDriver

Factory for record drivers that uses the class name to look up config files.

$ PublicationDetails#nameProperty in class PublicationDetails

Name of publisher

$ RouteGenerator#nonTabRecordActionsProperty in class RouteGenerator

Record sub-routes are generally used to access tab plug-ins, but a few URLs are hard-coded to specific actions; this array lists those actions.

$ Results#notificationFrequencyProperty in class Results

How frequently will a user be notified about this search (0 = never)?

NormalizedSearchClass in namespace VuFind\Search

Normalized search object.

$ NormalizedSearch#normalizedProperty in class NormalizedSearch

Normalized search object

SearchNormalizer::normalizeSearch() — Method in class SearchNormalizer

Normalize a search

SearchNormalizer::normalizeMinifiedSearch() — Method in class SearchNormalizer

Normalize a minified search

$ CustomFilterListener#normalFiltersProperty in class CustomFilterListener

Normal filters

Params::normalizeSort() — Method in class Params

Normalize sort parameters.

$ SpellingProcessor#normalizerProperty in class SpellingProcessor

Callback for normalizing text.

$ CspHeaderGenerator#nonceProperty in class CspHeaderGenerator

Generated nonce used for one request

NonceGeneratorClass in namespace VuFind\Security

VuFind class for generating nonce (number used once) used by content security policy.

NoneClass in namespace VuFind\UrlShortener

No-op URL shortener (default version, does nothing).

Config::nonJavascriptSupportEnabled() — Method in class Config

Is non-Javascript support enabled?

$ Flashmessages#namespacesProperty in class Flashmessages

Flash messenger namespaces

VuFindWorkKeys::normalize() — Method in class VuFindWorkKeys

Create a key string.

O

$ Suggester#optionsManagerProperty in class Suggester

Search options plugin manager.

ObalkyKnihServiceClass in namespace KnihovnyCz\Content

Class ObalkyKnihService

ObalkyKnihClass in namespace KnihovnyCz\Content\TOC

Class ObalkyKnih

InvolvedLibrariesBuilder::onDocumentParsed() — Method in class InvolvedLibrariesBuilder

Handler for onDocumentParsed event

Module::onBootstrap() — Method in class Module

Bootstrap the module

ObalkyKnihTraitClass in namespace KnihovnyCz\RecordDriver\Feature

Trait ObalkyKnihTrait

$ ObalkyKnihTrait#obalkyKnihProperty in class ObalkyKnihTrait

ObalkyKnih.cz API client

OptionsClass in namespace KnihovnyCz\Search\Favorites

Search Favorites Options

ChildDocDeduplicationListener::onSearchPre() — Method in class ChildDocDeduplicationListener

Set up filter for excluding merged children.

$ JsonFacetListener#orFacetsProperty in class JsonFacetListener

Or facets

JsonFacetListener::onSearchPre() — Method in class JsonFacetListener

Set up JSON API before search

MultiplyingDeduplicationListener::onSearchPre() — Method in class MultiplyingDeduplicationListener

Set up filter for excluding merge children.

MultiplyingDeduplicationListener::onSearchPost() — Method in class MultiplyingDeduplicationListener

Fetch appropriate dedup child

OneChildDocDeduplicationListenerClass in namespace KnihovnyCz\Search\Solr

Solr deduplication listener for views.

OverdriveControllerClass in namespace VuFindAdmin\Controller

Class controls distribution of tags and resource tags.

$ ApiTrait#outputModeProperty in class ApiTrait

Type of output to use

ApiTrait::onDispatch() — Method in class ApiTrait

Execute the request

ApiTrait::output() — Method in class ApiTrait

Send output data and exit.

SearchApiController::onDispatch() — Method in class SearchApiController

Execute the request

MergeMarcCommand::outputRecordsFromFile() — Method in class MergeMarcCommand

Given the filename of an XML document, feed any MARC records from the file to the output stream.

$ InstallCommand#overrideDirProperty in class InstallCommand

Local settings directory for VuFind installation.

$ NotifyCommand#outputProperty in class NotifyCommand

Output interface

DedupeCommand::openOutputFile() — Method in class DedupeCommand

Open a file for writing.

OptimizeCommandClass in namespace VuFindConsole\Command\Util

Console command: optimize Solr index

$ ConsoleOutputTrait#outputInterfaceProperty in class ConsoleOutputTrait

Output interface.

Module::onBootstrap() — Method in class Module

Bootstrap the module

Backend::onSearchPre() — Method in class Backend

Trigger pre-search events for all backends.

Backend::onSearchPost() — Method in class Backend

Trigger post-search events for all backends.

$ Backend#orgIdProperty in class Backend

Organization EDS API requests are being made for

$ Base#orgIdProperty in class Base

The organization id use for authentication

OptimizeDocumentClass in namespace VuFindSearch\Backend\Solr\Document

SOLR optimize document class.

$ Connector#optionsProperty in class Connector

Additional options

$ QueryBuilder#oclcCodeToExcludeProperty in class QueryBuilder

OCLC code to exclude from results

$ AlphabeticBrowseCommand#offsetDeltaProperty in class AlphabeticBrowseCommand

Delta to use when calculating page offset.

$ QueryOffsetLimitTrait#offsetProperty in class QueryOffsetLimitTrait

Search offset.

$ Query#operatorProperty in class Query

Operator to apply to query string (null if not applicable)

$ QueryGroup#operatorsProperty in class QueryGroup

Valid boolean operators.

$ QueryGroup#operatorProperty in class QueryGroup

Boolean operator.

$ AbstractRecordCollection#offsetProperty in class AbstractRecordCollection

Zero-based offset in complete search result.

OptimizeDocumentTestClass in namespace VuFindTest\Backend\Solr\Document

Unit tests for SOLR update document class.

OptimizeCommandTestClass in namespace VuFindTest\Command\Util

OptimizeCommand test.

OpenLibraryTestClass in namespace VuFindTest\Content\Covers

Unit tests for OpenLibrary cover loader.

OAuth2TokenTraitTestClass in namespace VuFindTest\ILS

Class OAuth2TokenTraitTest

Office365TestClass in namespace VuFindTest\Log\Writer

Office 365 Log Writer Test Class

CartTest::openCartLightbox() — Method in class CartTest

Open the cart lightbox.

OAuth2TestClass in namespace VuFindTest\Mink

OAuth2/OIDC test class.

$ OAuth2Test#opensslKeyPairCreatedProperty in class OAuth2Test

Whether a key pair has been created

$ IdentityRepositoryTest#oauth2ConfigProperty in class IdentityRepositoryTest

OAuth2 configuration

OpenLibrarySubjectsDeferredTestClass in namespace VuFindTest\Recommend

OpenLibrarySubjectsDeferred recommendation module Test Class

$ AlmaTest#openUrlConfigProperty in class AlmaTest
Test-Config
$ JopTest#openUrlConfigProperty in class JopTest
Test-Config
$ RediTest#openUrlConfigProperty in class RediTest
Test-Config
OptionsTestClass in namespace VuFindTest\Search\Blender

Blender Options Test

OnCampusListenerTestClass in namespace VuFindTest\Search\Primo

Unit tests for OnCampus listener.

OptionsTestClass in namespace VuFindTest\Search\Solr

Solr Search Object Options Test

OptionsClass in namespace VuFindTest\Search\TestHarness

Test options search model.

OpenUrlTestClass in namespace VuFindTest\View\Helper\Root

OpenUrl Test Class

$ AbstractCssPreCompiler#outputProperty in class AbstractCssPreCompiler

Output object (set for logging)

ConcatTrait::outputInOrder() — Method in class ConcatTrait

Process and return items in index order

$ DoiLookup#openInNewWindowProperty in class DoiLookup

Whether to open links in a new window

OCLCIdentitiesClass in namespace VuFind\Autocomplete

OCLC Identities Autocomplete Module

$ Suggester#optionsManagerProperty in class Suggester

Search options plugin manager.

$ Upgrade#oldDirProperty in class Upgrade

Directory containing configurations to upgrade

$ Upgrade#oldConfigsProperty in class Upgrade

Parsed old configurations

OpenLibraryClass in namespace VuFind\Connection

Open Library Utilities

OracleClass in namespace VuFind\Connection

Oracle support code for VTLS Virtua Driver

$ BlockLoader#optionsManagerProperty in class BlockLoader

Options manager.

ObalkyKnihClass in namespace VuFind\Content\Covers

Class ObalkyKnih

OpenLibraryClass in namespace VuFind\Content\Covers

OpenLibrary cover content loader.

OrbClass in namespace VuFind\Content\Covers

Orb cover content loader.

OrbFactoryClass in namespace VuFind\Content\Covers

Orb cover loader factory

ObalkyKnihContentFactoryClass in namespace VuFind\Content

Class ObalkyKnihCoversFactory

ObalkyKnihServiceClass in namespace VuFind\Content

Service class for ObalkyKnih

ObalkyKnihServiceFactoryClass in namespace VuFind\Content

Class ObalkyKnihCoversFactory

CatchIlsExceptionsTrait::onDispatch() — Method in class CatchIlsExceptionsTrait

Execute the request

HierarchyController::output() — Method in class HierarchyController

XML output routine

HierarchyController::outputJSON() — Method in class HierarchyController

Output JSON

OAuth2ControllerClass in namespace VuFind\Controller

OAuth2 Controller

$ OAuth2Controller#oauth2ConfigProperty in class OAuth2Controller

OAuth2 configuration

$ OAuth2Controller#oauth2ServerFactoryProperty in class OAuth2Controller

OAuth2 authorization server factory

OAuth2Controller::onDispatch() — Method in class OAuth2Controller

Execute the request

OAuth2ControllerFactoryClass in namespace VuFind\Controller

OAuth2 controller factory.

$ OAuth2ControllerFactory#oauth2ConfigProperty in class OAuth2ControllerFactory

OAuth2 configuration

OaiControllerClass in namespace VuFind\Controller

OAIController Class

OverdriveControllerClass in namespace VuFind\Controller

Overdrive Controller supports actions for Overdrive Integration

SearchController::opensearchAction() — Method in class SearchController

Handle OpenSearch.

$ Loader#oclcProperty in class Loader

User OCLC number parameter

OaiResumptionClass in namespace VuFind\Db\Row

Row Definition for oai_resumption

OaiResumptionClass in namespace VuFind\Db\Table

Table Definition for oai_resumption

Search::onPreInit() — Method in class Search

Customize the database object to include extra metadata about the search_object field so that it will be written correctly. This is triggered only when we're interacting with PostgreSQL; MySQL works fine without the extra hint.

OverdriveConnectorClass in namespace VuFind\DigitalContent
OverdriveConnector
OverdriveConnectorFactoryClass in namespace VuFind\DigitalContent

Overdrive Connector factory.

$ BasemapConfig#optionsProperty in class BasemapConfig

Valid options to retrieve from configuration

OAuth2TokenTraitClass in namespace VuFind\ILS\Driver

Trait OAuth2TokenTraitTest

$ XCNCIP2#otherAcceptedHttpStatusCodesProperty in class XCNCIP2

Other than 2xx HTTP status codes, which could be accepted as correct response.

Office365Class in namespace VuFind\Log\Writer

This class extends the Laminas Logging to send errors to Office365 webhooks.

Module::onBootstrap() — Method in class Module

Bootstrap the module

$ UserEntity#oauth2ConfigProperty in class UserEntity

OAuth2 configuration

$ ClientRepository#oauth2ConfigProperty in class ClientRepository

OAuth2 server configuration

$ IdentityRepository#oauth2ConfigProperty in class IdentityRepository

OAuth2 configuration

$ ScopeRepository#oauth2ConfigProperty in class ScopeRepository

OAuth2 server configuration

$ AbstractFacets#orFacetsProperty in class AbstractFacets

Facets that are "ORed" instead of "ANDed."

OpenLibrarySubjectsClass in namespace VuFind\Recommend

OpenLibrarySubjects Recommendations Module

OpenLibrarySubjectsDeferredClass in namespace VuFind\Recommend

OpenLibrarySubjects Recommendations Module

$ SwitchQuery#optInMethodsProperty in class SwitchQuery

List of 'opt-in' methods (others are 'opt-out' by default).

$ VersionAwareTrait#otherVersionsCountProperty in class VersionAwareTrait

Cached result of other versions (work expressions) count

$ VersionAwareTrait#otherVersionsProperty in class VersionAwareTrait

Cached result of other versions (work expressions)

BackendManager::onResolve() — Method in class BackendManager

Listener for search system event resolve.

HideFacetValueListener::onSearchPost() — Method in class HideFacetValueListener

Hide facet values from display

OptionsClass in namespace VuFind\Search\Base

Abstract options search model.

$ Params#optionsProperty in class Params

Search options

$ Params#orFacetsProperty in class Params

Facets in "OR" mode

$ Params#overrideQueryProperty in class Params

Override Query

Results::overrideStartRecord() — Method in class Results

Manually override the start record number.

OptionsClass in namespace VuFind\Search\Blender

Blender Search Options

OptionsClass in namespace VuFind\Search\BrowZine

BrowZine Search Options

OptionsClass in namespace VuFind\Search\Combined

Combined search model.

OptionsClass in namespace VuFind\Search\EDS

EDS API Options

OptionsFactoryClass in namespace VuFind\Search\EDS

Factory for EDS search options objects.

OptionsClass in namespace VuFind\Search\EIT

EBSCO EIT Search Options Largely copied from WorldCat Search Options

OptionsClass in namespace VuFind\Search\EmptySet

Search EmptySet Options

OptionsClass in namespace VuFind\Search\Favorites

Search Favorites Options

OptionsClass in namespace VuFind\Search\LibGuides

LibGuides Search Options

OptionsClass in namespace VuFind\Search\MixedList

Search Mixed List Options

OptionsFactoryClass in namespace VuFind\Search\Options

Generic factory for search options objects.

OptionsClass in namespace VuFind\Search\Pazpar2

Pazpar2 Search Options

InjectOnCampusListener::onSearchPre() — Method in class InjectOnCampusListener

Set up onCampus Listener.

OptionsClass in namespace VuFind\Search\Primo

Primo Search Options

$ RecommendListener#objectsProperty in class RecommendListener

Recommendation modules, indexed by location.

RecommendListener::onSearchConfigured() — Method in class RecommendListener

Set up recommendation modules.

RecommendListener::onSearchComplete() — Method in class RecommendListener

Inject additional spelling suggestions.

OptionsClass in namespace VuFind\Search\Search2Collection

Search2 Collection Search Options

OptionsClass in namespace VuFind\Search\Search2

Search Options for second Solr index

OptionsClass in namespace VuFind\Search\SolrAuth

Solr Authority Search Options

OptionsClass in namespace VuFind\Search\SolrAuthorFacets

AuthorFacets Search Options

OptionsClass in namespace VuFind\Search\SolrAuthor

Author Search Options

OptionsClass in namespace VuFind\Search\SolrCollection

Solr Collection Search Options

OptionsClass in namespace VuFind\Search\SolrReserves

Solr Reserves Search Options

OptionsClass in namespace VuFind\Search\SolrWeb

Solr Web Search Options

AbstractErrorListener::onSearchError() — Method in class AbstractErrorListener

VuFindSearch.error event.

CustomFilterListener::onSearchPre() — Method in class CustomFilterListener

Apply/translate custom filters.

DeduplicationListener::onSearchPre() — Method in class DeduplicationListener

Set up filter for excluding merge children.

DeduplicationListener::onSearchPost() — Method in class DeduplicationListener

Fetch appropriate dedup child

DefaultParametersListener::onSearchPre() — Method in class DefaultParametersListener

Add default parameters

FilterFieldConversionListener::onSearchPre() — Method in class FilterFieldConversionListener

Set up conditional hidden filters.

HierarchicalFacetListener::onSearchPost() — Method in class HierarchicalFacetListener

Format hierarchical facets accordingly

InjectConditionalFilterListener::onSearchPre() — Method in class InjectConditionalFilterListener

Set up conditional hidden filters.

InjectHighlightingListener::onSearchPre() — Method in class InjectHighlightingListener

Set up highlighting parameters.

InjectHighlightingListener::onSearchPost() — Method in class InjectHighlightingListener

Inject highlighting results.

InjectSpellingListener::onSearchPre() — Method in class InjectSpellingListener

Set up spelling parameters.

InjectSpellingListener::onSearchPost() — Method in class InjectSpellingListener

Inject additional spelling suggestions.

MultiIndexListener::onSearchPre() — Method in class MultiIndexListener
VuFindSearch.pre()
OptionsClass in namespace VuFind\Search\Solr

Solr Search Options

ErrorListener::onSearchError() — Method in class ErrorListener
VuFindSearch.error
ErrorListener::onSearchError() — Method in class ErrorListener
VuFindSearch.error
OptionsClass in namespace VuFind\Search\Summon

Summon Search Options

OptionsClass in namespace VuFind\Search\Tags

Search Tags Options

OptionsClass in namespace VuFind\Search\WorldCat

WorldCat Search Options

AbstractBase::open() — Method in class AbstractBase

Open function, this works like a constructor in classes and is executed when the session is being opened.

SecureDelegator::open() — Method in class SecureDelegator

Opens a session.

Writer::optimize() — Method in class Writer

Optimize the index.

$ AbstractLayoutClass#offcanvasProperty in class AbstractLayoutClass

Is the sidebar offcanvas?

$ AlphaBrowse#optionsProperty in class AlphaBrowse

Additional configuration options.

OpenUrlClass in namespace VuFind\View\Helper\Root

OpenUrl view helper

$ OpenUrl#openUrlRulesProperty in class OpenUrl

OpenURL rules

OpenUrlFactoryClass in namespace VuFind\View\Helper\Root

OpenUrl helper factory.

OverdriveClass in namespace VuFind\View\Helper\Root

Overdrive view helper

OverdriveFactoryClass in namespace VuFind\View\Helper\Root

Overdrive helper factory.

$ Related#optionsManagerProperty in class Related

Plugin manager for search options.

$ ResultFeed#overrideTitleProperty in class ResultFeed

Override title

$ SearchBox#optionsManagerProperty in class SearchBox

Search options plugin manager

P

$ XCNCIP2Test#placeHoldTestsProperty in class XCNCIP2Test
$ XCNCIP2Test#placeStorageRetrievalRequestTestsProperty in class XCNCIP2Test
$ XCNCIP2Test#profileTestsProperty in class XCNCIP2Test
$ XCNCIP2Test#patronBlocksTestsProperty in class XCNCIP2Test
Sfx::parseResponse() — Method in class Sfx

Parse SFX response and return link to fulltext or false.

$ Highlighter#patternsProperty in class Highlighter

Search phrases to use for highlighting

$ Suggester#pluginManagerProperty in class Suggester

Autocomplete plugin manager.

PluginFactoryClass in namespace KnihovnyCz\Config

Class PluginFactory

PluginManagerClass in namespace KnihovnyCz\Config

Class PluginManager

PluginManagerFactoryClass in namespace KnihovnyCz\Config

Class PluginManagerFactory

PageLocatorClass in namespace KnihovnyCz\Content

Class PageLocator

PageLocatorFactoryClass in namespace KnihovnyCz\Content

Class PageLocatorFactory

LibraryCardsController::processEditLibraryCard() — Method in class LibraryCardsController

Process the "edit library card" submission. Only update card name.

MyResearchController::profileAction() — Method in class MyResearchController

Gather user profile data

MyResearchController::profileAjaxAction() — Method in class MyResearchController

Send user profile data as HTML for rendering in AJAX

MyResearchController::prolongationPaymentAction() — Method in class MyResearchController

Action for finished payment of registration prolongation

MyResearchController::processAuthenticationException() — Method in class MyResearchController

Process an authentication error.

ShortLoans::placeHolds() — Method in class ShortLoans

Process place holds

PortalPageControllerClass in namespace KnihovnyCz\Controller

Class PortalPageController

ZiskejController::paymentAction() — Method in class ZiskejController

Ziskej payment page

Converter::parseDisplayDate() — Method in class Converter

Public method for conversion of an admin defined date string to a PHP DateTime

$ User#passwordProperty in class User
$ User#pass_hashProperty in class User
$ User#pending_emailProperty in class User
ParserClass in namespace KnihovnyCz\Geo

Class Parser

Parser::parseRangeQuery() — Method in class Parser

Parse range query, normalize it and return min and max value.

Parser::parseBoundingBoxForDisplay() — Method in class Parser

Parse bounding box and return user friendly representation.

Parser::parseBoundingBox() — Method in class Parser

Parse bounding box from filter and return as points

Aleph::placeShortLoan() — Method in class Aleph

Place short loan request

Aleph::parseTime() — Method in class Aleph

Parse a time.

Aleph::parseDate() — Method in class Aleph

Parse a date.

KohaRest::patronLogin() — Method in class KohaRest

Patron Login

KohaRest1905::placeHold() — Method in class KohaRest1905

Place Hold

KohaRest1905::patronLogin() — Method in class KohaRest1905

Patron Login

KohaRest1905::pickUpLocationIsValid() — Method in class KohaRest1905

Is the selected pickup location valid for the hold?

MultiBackend::processOverdueTransactions() — Method in class MultiBackend

Set overdue status for expired transactions

NoILS::patronLogin() — Method in class NoILS

Patron Login

XCNCIP2::parsePage() — Method in class XCNCIP2

Parse page from params to string usable for XML

MultiConnection::patronLogin() — Method in class MultiConnection

Patron login

$ MapSelection#parserProperty in class MapSelection

Geo parser

RecommendOtherPortals::process() — Method in class RecommendOtherPortals

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

PatentTraitClass in namespace KnihovnyCz\RecordDriver\Feature

Trait PatentTrait

$ SolrDefault#preferredSnippetFieldsProperty in class SolrDefault

These Solr fields should be used for snippets if available (listed in order of preference).

$ SolrDefault#parentRecordProperty in class SolrDefault

Parent record

SolrDublinCore::parseXML() — Method in class SolrDublinCore

Parse this record XML data into object

SolrMarc::parsePageStartFromField773() — Method in class SolrMarc

Get page start (parsed from field 773)

SolrMarc::parsePageEndFromField773() — Method in class SolrMarc

Get page end (parsed from field 773)

Connector::process() — Method in class Connector

Process EDSAPI response message

ParamBagClass in namespace KnihovnyCz\Search

Lightweight wrapper for request parameters.

ParamsClass in namespace KnihovnyCz\Search\Search2

Solr Search Parameters

$ Connector#performanceLoggerProperty in class Connector

Performance logger

PerformanceLoggerClass in namespace KnihovnyCz\Search\Solr\Backend

Solr performance logger

RecordCollection::parseFacets() — Method in class RecordCollection

Parse facets from response

DeduplicationHelper::parseField() — Method in class DeduplicationHelper

Parse field and local parameters from faceting parameter

$ JsonFacetListener#parentCountProperty in class JsonFacetListener

Return parent count - make faceting slower

JsonFacetListener::process() — Method in class JsonFacetListener

Transform parameters for JSON API

ParamsClass in namespace KnihovnyCz\Search\Solr

Solr Search Parameters

$ Params#parserProperty in class Params

Array of functions for boosting the query

ParamsFactoryClass in namespace KnihovnyCz\Search\Solr

Factory for Solr search params objects.

$ GuzzleHttpService#proxyProperty in class GuzzleHttpService
Configuration
$ SparqlService#prefixesProperty in class SparqlService
$ OverdriveController#paramsProperty in class OverdriveController
Params
$ TagsController#paramsProperty in class TagsController
Params
PluginCommandClass in namespace VuFindConsole\Command\Generate

Console command: Generate plugin.

$ HarvestOaiCommand#pathResolverProperty in class HarvestOaiCommand

Config file path resolver

InstallCommand::processParameters() — Method in class InstallCommand

Process collected parameters, and return a status (0 = proceed, 1 = fail).

AbstractCommand::processDirectory() — Method in class AbstractCommand

Process a language directory.

PluginManagerClass in namespace VuFindConsole\Command

Console command plugin manager

NotifyCommand::processViewAlerts() — Method in class NotifyCommand

Send scheduled alerts for a view.

$ SwitchDbHashCommand#pathResolverProperty in class SwitchDbHashCommand

Config file path resolver

$ ConsoleRunner#pluginManagerProperty in class ConsoleRunner

Plugin manager (to retrieve commands)

AbstractHandlerMap::prepare() — Method in class AbstractHandlerMap

Prepare final set of parameters for search function.

Backend::processBackendFailures() — Method in class Backend

Process any backend exceptions and throw an exception if all failed or add an error message if some of them failed.

$ Backend#passwordProperty in class Backend

Password for EBSCO EDS API account if using UID Authentication

$ Backend#profileProperty in class Backend

Profile for EBSCO EDS API account (may be overridden)

Backend::paramBagToEBSCOSearchModel() — Method in class Backend

Convert a ParamBag to a EdsApi Search request object.

Base::parseAutocomplete() — Method in class Base

Parse autocomplete response from API in an array of terms

Base::process() — Method in class Base

Process EDS API response message

$ SearchRequestModel#pageNumberProperty in class SearchRequestModel

Page number of records to return. This is used in conjunction with the $resultsPerPage to determine the set of records to return.

$ Connector#profProperty in class Connector

EBSCO EIT Profile used for authentication

$ Connector#pwdProperty in class Connector

Password associated with the EBSCO EIT Profile

ConnectorCacheTrait::putCachedData() — Method in class ConnectorCacheTrait

Cache response data.

Backend::paramBagToArray() — Method in class Backend

Convert a ParamBag to a query array.

Connector::process() — Method in class Connector

Translate API response into more convenient format.

Connector::prepareParams() — Method in class Connector

Prepare API parameters

$ Backend#progressTargetProperty in class Backend

How much search progress should be completed before returning results (a value between 0 and 1).

Connector::ping() — Method in class Connector

Keeps a session alive. An idle session will time out after one minute.

Backend::paramBagToPrimoQuery() — Method in class Backend

Convert a ParamBag to a Primo query array.

Connector::performSearch() — Method in class Connector

Support method for query() -- perform inner search logic

Connector::process() — Method in class Connector

Translate Primo's XML into array of arrays.

Connector::processHighlighting() — Method in class Connector

Process highlighting tags of the record fields

Connector::processDescription() — Method in class Connector

Fix the description field by removing tags etc.

Connector::process() — Method in class Connector

Process an SRU response. Returns either the raw XML string or a SimpleXMLElement based on the contents of the class' raw property.

$ Backend#pageSizeProperty in class Backend

Limit for records per query in a batch retrieval.

$ HandlerMap#parametersProperty in class HandlerMap

Query defaults/appends/invariants, indexed by handler.

LuceneSyntaxHelper::prepareForLuceneSyntax() — Method in class LuceneSyntaxHelper

Prepare input to be used in a SOLR query.

LuceneSyntaxHelper::processQueryString() — Method in class LuceneSyntaxHelper

Process a Lucene query string with a callback

SearchHandler::preprocessQueryString() — Method in class SearchHandler

Apply standard pre-processing to the query string.

Backend::paramBagToSummonQuery() — Method in class Backend

Convert a ParamBag to a Summon query object.

$ AbstractBase#paramsProperty in class AbstractBase

Search backend parameters

$ AlphabeticBrowseCommand#pageProperty in class AlphabeticBrowseCommand

Result page to return.

ParamBagClass in namespace VuFindSearch

Lightweight wrapper for request parameters.

$ ParamBag#paramsProperty in class ParamBag
Parameters
$ AbstractRecordCollection#pointerProperty in class AbstractRecordCollection

Array pointer

PluginManagerTestClass in namespace VuFindTest\Auth

Auth Plugin Manager Test Class

$ ShibbolethTest#proxyUserProperty in class ShibbolethTest
PluginManagerTestClass in namespace VuFindTest\AuthorNotes\Content

Content AuthorNotes Plugin Manager Test Class

PluginManagerTestClass in namespace VuFindTest\Autocomplete

Autocomplete Plugin Manager Test Class

PluginCommandTestClass in namespace VuFindTest\Command\Generate

Generate/Plugin command test.

SwitchDbHashCommandTest::prepareMock() — Method in class SwitchDbHashCommandTest

Prepare a mock object

PathResolverTestClass in namespace VuFindTest\Config

Config Path Resolver Test Class

PluginFactoryTestClass in namespace VuFindTest\Config

Config Factory Test Class

PageLocatorTestClass in namespace VuFindTest\Content

Content Page Locator Test Class

PluginManagerTestClass in namespace VuFindTest\Content

Content Plugin Manager Test Class

PluginManagerTestClass in namespace VuFindTest\Covers\Content

Content Covers Plugin Manager Test Class

PluginManagerTestClass in namespace VuFindTest\Db\Table

DB Table Plugin Manager Test Class

PluginManagerTestClass in namespace VuFindTest\Excerpts\Content

Content Excerpts Plugin Manager Test Class

PathResolverTraitClass in namespace VuFindTest\Feature

Trait for tests involving PathResolver.

PluginManagerTestClass in namespace VuFindTest\Hierarchy\Driver

Hierarchy Driver Plugin Manager Test Class

PluginManagerTestClass in namespace VuFindTest\Hierarchy\TreeDataSource

Hierarchy Tree Data Source Plugin Manager Test Class

PluginManagerTestClass in namespace VuFindTest\Hierarchy\TreeRenderer

Hierarchy Tree Renderer Plugin Manager Test Class

ILSMockTrait::placeHold() — Method in class ILSMockTrait
ILSMockTrait::placeILLRequest() — Method in class ILSMockTrait
ILSMockTrait::placeStorageRetrievalRequest() — Method in class ILSMockTrait
PAIATestClass in namespace VuFindTest\ILS\Driver

ILS driver test

$ PAIATest#patronProperty in class PAIATest
$ PAIATest#patron_badProperty in class PAIATest
$ PAIATest#patron_expiredProperty in class PAIATest
$ PAIATest#pwchangeTestResultProperty in class PAIATest
$ PAIATest#profileTestResultProperty in class PAIATest
PluginManagerTestClass in namespace VuFindTest\ILS\Driver

ILS Driver Plugin Manager Test Class

PolarisTestClass in namespace VuFindTest\ILS\Driver

ILS driver test

$ XCNCIP2Test#profileTestsProperty in class XCNCIP2Test

Test definition for testGetMyProfile

$ XCNCIP2Test#placeHoldTestsProperty in class XCNCIP2Test

Test definition for testPlaceHold

$ XCNCIP2Test#placeStorageRetrievalRequestTestsProperty in class XCNCIP2Test

Test definition for testPlaceStorageRetrievalRequest

$ XCNCIP2Test#patronBlocksTestsProperty in class XCNCIP2Test

Test definitions for getPatronBlocks tests

PaginationHelperTestClass in namespace VuFindTest\ILS

Pagination helper test

$ MinkTestCase#pathResolverProperty in class MinkTestCase

Configuration file path resolver

MinkTestCase::performSearch() — Method in class MinkTestCase

Search for the specified query.

PostTestClass in namespace VuFindTest\Log\Writer

POST Log Writer Test Class

MockEmailRenderer::partial() — Method in class MockEmailRenderer
PRISMTestClass in namespace VuFindTest\MetadataVocabulary

PRISM Test Class

HoldsTest::placeHoldAndGoToHoldsScreen() — Method in class HoldsTest

Support method to place a hold and click through to "Your Holds and Recalls."

IlsActionsTest::placeIllRequestAndGoToIllScreen() — Method in class IlsActionsTest

Support method to place an ILL request and end up on the ILL screen.

IlsActionsTest::placeStorageRetrievalRequestAndGoToSRRScreen() — Method in class IlsActionsTest

Support method to place a storage retrieval request and end up on the SRR screen.

ParamBagTestClass in namespace VuFindTest

Unit tests for ParamBag.

PluginManagerTestClass in namespace VuFindTest\Recommend

Recommend Plugin Manager Test Class

PluginManagerTestClass in namespace VuFindTest\RecordDriver

RecordDriver Plugin Manager Test Class

PublicationDetailsTestClass in namespace VuFindTest\RecordDriver\Response

SolrMarc Record Driver Test Class

PluginManagerTestClass in namespace VuFindTest\RecordTab

RecordTab Plugin Manager Test Class

PreviewTestClass in namespace VuFindTest\RecordTab

Preview Test Class

PluginManagerTestClass in namespace VuFindTest\Related

Related Items Plugin Manager Test Class

PluginManagerTestClass in namespace VuFindTest\Resolver\Driver

Resolver\Driver Plugin Manager Test Class

PluginManagerTestClass in namespace VuFindTest\Reviews\Content

Content Reviews Plugin Manager Test Class

PermissionDeniedManagerTestClass in namespace VuFindTest\Role

PermissionManager Test Class

$ PermissionDeniedManagerTest#permissionDeniedConfigProperty in class PermissionDeniedManagerTest

Sample configuration with varios config options.

PermissionManagerTestClass in namespace VuFindTest\Role

PermissionManager Test Class

$ PermissionManagerTest#permissionConfigProperty in class PermissionManagerTest

Sample configuration with varios config options.

PluginManagerTestClass in namespace VuFindTest\Role\PermissionProvider

PermissionProvider Plugin Manager Test Class

ParamsTestClass in namespace VuFindTest\Search\Base

Base Search Object Parameters Test

ParamsTestClass in namespace VuFindTest\Search\Blender

Blender Params Test

$ ParamsTest#primoConfigProperty in class ParamsTest

Primo configuration

ParamsTestClass in namespace VuFindTest\Search\EDS

EDS Search Object Parameters Test

PluginManagerTestClass in namespace VuFindTest\Search\Options

Search\Options Plugin Manager Test Class

PluginManagerTestClass in namespace VuFindTest\Search\Params

Search\Params Plugin Manager Test Class

ParamsTestClass in namespace VuFindTest\Search\Primo

Unit tests for Primo Params.

PrimoPermissionHandlerTestClass in namespace VuFindTest\Search\Primo

Unit tests for Primo Permission Handler.

$ PrimoPermissionHandlerTest#primoConfigProperty in class PrimoPermissionHandlerTest

Sample configuration.

$ PrimoPermissionHandlerTest#primoConfigWithoutDefaultProperty in class PrimoPermissionHandlerTest

Sample configuration without default.

$ PrimoPermissionHandlerTest#primoConfigDefaultOnlyProperty in class PrimoPermissionHandlerTest

Sample configuration with default with onCampusRule.

$ PrimoPermissionHandlerTest#primoConfigInstitutionCodeProperty in class PrimoPermissionHandlerTest

Sample configuration with institution code.

$ PrimoPermissionHandlerTest#primoConfigWithoutDefaultWithInstCodeProperty in class PrimoPermissionHandlerTest

Sample configuration without default, but with institutionCode setting.

$ PrimoPermissionHandlerTest#primoConfigDefaultOnlyNoOnCampusRuleProperty in class PrimoPermissionHandlerTest

Sample configuration with default only.

PluginManagerTestClass in namespace VuFindTest\Search\Results

Search\Results Plugin Manager Test Class

ParamsTestClass in namespace VuFindTest\Search\Solr

Solr Search Object Parameters Test

ParamsTestClass in namespace VuFindTest\Search\Summon

Summon Search Object Parameters Test

ParamsClass in namespace VuFindTest\Search\TestHarness

Test params search model.

Results::performSearch() — Method in class Results

Abstract support method for performAndProcessSearch -- perform a search based on the parameters passed to the object. This method is responsible for filling in all of the key class properties: results, resultTotal, etc.

$ FileTest#pathProperty in class FileTest

Path to session files

PluginManagerTestClass in namespace VuFindTest\Session

Session Plugin Manager Test Class

$ TagsTest#parserProperty in class TagsTest

Tag parser

ParentTemplateTestClass in namespace VuFindTest\View\Helper

ParentTemplate view helper Test Class

ContentTest::performTest() — Method in class ContentTest

Perform a test of the helper.

PermissionTestClass in namespace VuFindTest\View\Helper\Root

Permission view helper Test Class

$ PermissionTest#permissionDeniedConfigProperty in class PermissionTest

Sample configuration with varios config options.

VuFindGeoTest::popMessage() — Method in class VuFindGeoTest
AbstractCssPreCompiler::processTheme() — Method in class AbstractCssPreCompiler

Compile scripts for the specified theme.

Initializer::pickTheme() — Method in class Initializer

Support method for init() -- figure out which theme option is active.

$ InjectTemplateListener#prefixesProperty in class InjectTemplateListener

List of prefixes for theme files

PathConverterClass in namespace VuFindTheme\Minify

CSS path converter extension

ResourceContainer::parseSetting() — Method in class ResourceContainer

Given a colon-delimited configuration string, break it apart, making sure that URLs in the first position are not inappropriately split.

ScssCompiler::processTheme() — Method in class ScssCompiler

Compile scripts for the specified theme.

$ ThemeGenerator#pathResolverProperty in class ThemeGenerator

Config file path resolver

ParentTemplateClass in namespace VuFindTheme\View\Helper

Helper to get path to a parent template (for including)

ParentTemplateFactoryClass in namespace VuFindTheme\View\Helper

ParentTemplate helper factory.

PipelineInjectorFactoryClass in namespace VuFindTheme\View\Helper

Factory for helpers relying on asset pipeline configuration.

Slot::prepend() — Method in class Slot

Add string to list of block prepends.

$ TemplatePath#pathPreProperty in class TemplatePath

Absolute path up to the theme name

$ TemplatePath#pathPostProperty in class TemplatePath

Absolute path after the theme name

$ DoiLookup#pluginManagerProperty in class DoiLookup

DOI Linker Plugin Manager

$ DoiLookup#proxyIconsProperty in class DoiLookup

Whether to load icons via the cover proxy

DoiLookup::processIconLinks() — Method in class DoiLookup

Proxify external DOI icon links and render local icons

GetItemStatuses::pickValue() — Method in class GetItemStatuses

Support method for getItemStatuses() -- when presented with multiple values, pick which one(s) to send back via AJAX.

$ GetResolverLinks#pluginManagerProperty in class GetResolverLinks

Resolver driver plugin manager

$ GetUserTransactions#paginationHelperProperty in class GetUserTransactions
Paginator
GetVisData::processDateFacets() — Method in class GetVisData

Extract details from applied filters.

GetVisData::processFacetValues() — Method in class GetVisData

Filter bad values from facet lists and add useful data fields.

PluginManagerClass in namespace VuFind\AjaxHandler

AJAX handler plugin manager

$ Recommend#pluginManagerProperty in class Recommend

Recommendation plugin manager

AbstractBase::preLoginCheck() — Method in class AbstractBase

Inspect the user's request prior to processing a login request; this is essentially an event hook which most auth modules can ignore. See ChoiceAuth for a use case example.

$ CAS#phpCASSetupProperty in class CAS

Already Setup phpCAS

ChoiceAuth::preLoginCheck() — Method in class ChoiceAuth

Inspect the user's request prior to processing a login request; this is essentially an event hook which most auth modules can ignore. See ChoiceAuth for a use case example.

ChoiceAuth::proxyAuthMethod() — Method in class ChoiceAuth

Proxy auth method; a helper function to be called like: return $this->proxyAuthMethod(METHOD, func_get_args());

ChoiceAuth::proxyUserLoad() — Method in class ChoiceAuth

Proxy auth method that checks the request for an active method and then loads a User object from the database (e.g. authenticate or create).

$ Database#passwordProperty in class Database
Password
Database::passwordHashingEnabled() — Method in class Database

Is password hashing enabled?

Email::processUser() — Method in class Email

Update the database using login user details, then return the User object.

ILS::processILSUser() — Method in class ILS

Update the database using details from the ILS, then return the User object.

ILSAuthenticator::processEmailLoginHash() — Method in class ILSAuthenticator

Process email login

LDAP::processLDAPUser() — Method in class LDAP

Build a User object from details obtained via LDAP.

$ Manager#pluginManagerProperty in class Manager

Authentication plugin manager

Manager::processPolicyConfig() — Method in class Manager

Process a raw policy configuration

$ MultiAuth#passwordProperty in class MultiAuth

Password input

PasswordAccessClass in namespace VuFind\Auth

Password Access authentication class

PluginFactoryClass in namespace VuFind\Auth

Auth handler plugin factory

PluginManagerClass in namespace VuFind\Auth

Auth handler plugin manager

SIP2::processSIP2User() — Method in class SIP2

Process SIP2 User Account

PluginFactoryClass in namespace VuFind\Autocomplete

Autocomplete handler plugin factory

PluginManagerClass in namespace VuFind\Autocomplete

Autocomplete handler plugin manager

Solr::pickBestMatch() — Method in class Solr

Given the values from a Solr field and the user's search query, pick the best match to display as a recommendation.

$ Suggester#pluginManagerProperty in class Suggester

Autocomplete plugin manager.

Importer::processHeader() — Method in class Importer

Process the header row, and generate a configuration.

Importer::processConfiguration() — Method in class Importer

Determine the list of fields that will be loaded.

Importer::processCallback() — Method in class Importer

Apply a single callback to a single value.

Importer::processValues() — Method in class Importer

Process the values from a single column of a CSV.

CacheTrait::putCachedData() — Method in class CacheTrait

Helper function for storing cached data.

PluginManagerClass in namespace VuFind\Captcha

CAPTCHA plugin manager

$ AbstractChannelProvider#providerIdProperty in class AbstractChannelProvider

Provider ID

ChannelLoader::performChannelSearch() — Method in class ChannelLoader

Get a search results object configured by channel providers.

PluginFactoryClass in namespace VuFind\ChannelProvider

Channel provider plugin factory

PluginManagerClass in namespace VuFind\ChannelProvider

Channel provider plugin manager

$ Random#paramManagerProperty in class Random

Params manager

PathResolverClass in namespace VuFind\Config

Configuration File Path Resolver

PathResolverFactoryClass in namespace VuFind\Config

Factory for PathResolver.

PluginFactoryClass in namespace VuFind\Config

VuFind Config Plugin Factory

PluginManagerClass in namespace VuFind\Config

VuFind Config Manager

PluginManagerFactoryClass in namespace VuFind\Config

Plugin Manager factory.

$ Upgrade#permissionsModifiedProperty in class Upgrade

Have we modified permissions.ini?

$ YamlReader#pathResolverProperty in class YamlReader

Config file path resolver

YamlReader::parseYaml() — Method in class YamlReader

Process a YAML file (and its parent, if necessary).

OpenLibrary::processSubjectsApi() — Method in class OpenLibrary

Return the following array of values for each work: title, cover_id, cover_id_type, key, ia, mainAuthor

Oracle::prepare() — Method in class Oracle

Wrapper around oci_parse.

Oracle::prepRowId() — Method in class Oracle

Wrapper around oci_new_descriptor.

Relais::placeRequest() — Method in class Relais

Place a request

$ Wikipedia#pagesRetrievedProperty in class Wikipedia

Log of Wikipedia pages already retrieved

Wikipedia::parseWikipedia() — Method in class Wikipedia
_parseWikipedia
WorldCatUtils::processIdentitiesSubjects() — Method in class WorldCatUtils

Support method for getRelatedIdentities() -- extract subject headings from the current node of the Identities API response.

PluginManagerClass in namespace VuFind\ContentBlock

Content block plugin manager

$ TemplateBased#pageLocatorProperty in class TemplateBased

Page content

PluginManagerClass in namespace VuFind\Content\AuthorNotes

Author notes content loader plugin manager

$ ContentCafe#passwordProperty in class ContentCafe

API password

PluginManagerClass in namespace VuFind\Content\Covers

Covers content loader plugin manager

PluginManagerClass in namespace VuFind\Content\Excerpts

Excerpts content loader plugin manager

$ Loader#providersProperty in class Loader

Provider information

PageLocatorClass in namespace VuFind\Content

Class PageLocator

PageLocatorFactoryClass in namespace VuFind\Content

Page locator factory

PluginManagerClass in namespace VuFind\Content

Content loader plugin manager

PluginManagerClass in namespace VuFind\Content\Reviews

Reviews content loader plugin manager

PluginManagerClass in namespace VuFind\Content\Summaries

Summaries content loader plugin manager

PluginManagerClass in namespace VuFind\Content\TOC

TOC content loader plugin manager

AbstractBase::permission() — Method in class AbstractBase

Permission plugin

AbstractRecord::processSave() — Method in class AbstractRecord

ProcessSave -- store the results of the Save action.

AbstractRecord::permalinkAction() — Method in class AbstractRecord

Show permanent link for the current record.

AbstractSearch::processJumpTo() — Method in class AbstractSearch

Process the jumpto parameter -- either redirect to a specific record and return view model, or ignore the parameter and return false.

AbstractSearch::parseSpecialFacetsSetting() — Method in class AbstractSearch

Parse the "special facets" setting.

AbstractSearch::processAdvancedCheckboxes() — Method in class AbstractSearch

Process the checkbox setting from special facets.

AbstractSolrSearch::processAdvancedFacets() — Method in class AbstractSolrSearch

Process the facets to be used as limits on the Advanced Search screen.

$ AjaxResponseTrait#php_errorsProperty in class AjaxResponseTrait

Array of PHP errors captured during execution. Add this code to your constructor in order to populate the array: set_error_handler([static::class, 'storeError']);

BrowseController::performSearch() — Method in class BrowseController

Perform the search

BrowseController::performBrowse() — Method in class BrowseController

Generic action function that handles all the common parts of the below actions

CartController::processorAction() — Method in class CartController

Process requests for main cart.

CartController::printcartAction() — Method in class CartController

Print a batch of records.

$ CoverController#proxyProperty in class CoverController

Proxy loader

EdsController::processAdvancedFacets() — Method in class EdsController

Process the facets to be used as limits on the Advanced Search screen.

EdsController::processAdvancedExpanders() — Method in class EdsController

Process the expanders to be used on the Advanced Search screen.

EdsController::processPublicationDateRange() — Method in class EdsController

Process the publicationd date range limiter widget

EdsController::processAdvancedSearchModes() — Method in class EdsController

Process the search modes to be used on the Advanced Search screen.

EdsrecordController::pdfAction() — Method in class EdsrecordController

PDF display action.

ErrorController::permissionDeniedAction() — Method in class ErrorController

Display permission denied message.

FeedbackController::prefillUserInfo() — Method in class FeedbackController

Prefill form sender fields for logged in users.

InstallController::phpVersionIsNewEnough() — Method in class InstallController

Support method for check/fix dependencies code -- do we have a new enough version of PHP?

InstallController::performsecurityfixAction() — Method in class InstallController

Perform fix for Security problems.

LibraryCardsController::processEditLibraryCard() — Method in class LibraryCardsController

Process the "edit library card" submission.

LibraryCardsController::processEmailLink() — Method in class LibraryCardsController

Process library card addition via an email link

$ MyResearchController#paginationHelperProperty in class MyResearchController

ILS Pagination Helper

MyResearchController::processAuthenticationException() — Method in class MyResearchController

Process an authentication error.

MyResearchController::profileAction() — Method in class MyResearchController

Gather user profile data

MyResearchController::performDeleteFavorite() — Method in class MyResearchController

Delete record

MyResearchController::processEditSubmit() — Method in class MyResearchController

Process the submission of the edit favorite form.

MyResearchController::processEditList() — Method in class MyResearchController

Process the "edit list" submission.

$ OAuth2Controller#pathResolverProperty in class OAuth2Controller

Config file path resolver

$ OAuth2ControllerFactory#pathResolverProperty in class OAuth2ControllerFactory

Config file path resolver

Pazpar2ControllerClass in namespace VuFind\Controller

Pazpar2 Controller

Pazpar2recordControllerClass in namespace VuFind\Controller

Pazpar2 Record Controller

DbUpgrade::parseKeysFromCreateTable() — Method in class DbUpgrade

Parse keys from a "create table" statement

PermissionClass in namespace VuFind\Controller\Plugin

VuFind Action Helper - Permission Checker

$ Permission#permissionManagerProperty in class Permission

Permission manager

$ Permission#permissionDeniedManagerProperty in class Permission

Permission denied manager

PermissionFactoryClass in namespace VuFind\Controller\Plugin

Factory for Permission controller plugin.

Renewals::processRenewals() — Method in class Renewals

Process renewal requests.

PrimoControllerClass in namespace VuFind\Controller

Primo Central Controller

PrimorecordControllerClass in namespace VuFind\Controller

Primo Central Record Controller

ShibbolethLogoutNotificationController::postAction() — Method in class ShibbolethLogoutNotificationController

POST method handler for the logout handler

SummonController::processAdvancedFacets() — Method in class SummonController

Process the facets to be used as limits on the Advanced Search screen.

UpgradeController::processSkipParam() — Method in class UpgradeController

Make sure we only skip the actions the user wants us to.

WebController::processJumpTo() — Method in class WebController

Process the jumpto parameter -- either redirect to a specific record and return view model, or ignore the parameter and return false.

$ CookieManager#pathProperty in class CookieManager

Cookie base path

CookieManager::proxySetCookie() — Method in class CookieManager

Support method for setGlobalCookie -- proxy PHP's setcookie() function for compatibility with unit testing.

PluginManagerClass in namespace VuFind\Cover\Layer

Cover layer plugin manager

Loader::processImageURLForSource() — Method in class Loader

Wrapper around processImageURL to determine cache setting based on image source.

Loader::processImageURL() — Method in class Loader

Load image from URL, store in cache if requested, display if possible.

$ OaiResumption#paramsProperty in class OaiResumption
PluginManagerClass in namespace VuFind\Db\Row

Database row plugin manager

PrivateUserClass in namespace VuFind\Db\Row

Fake database row to represent a user in privacy mode.

$ User#passwordProperty in class User
$ User#pass_hashProperty in class User
$ User#pending_emailProperty in class User
User::passwordEncryptionEnabled() — Method in class User

Is ILS password encryption enabled?

$ UserFactory#privateUserClassProperty in class UserFactory

Class name for private user class.

$ UserList#publicProperty in class UserList
PluginFactoryClass in namespace VuFind\Db\Table

Database table plugin factory

PluginManagerClass in namespace VuFind\Db\Table

Database table plugin manager

ResourceTags::processDestroyLinks() — Method in class ResourceTags

Process link rows marked to be destroyed.

OverdriveConnector::placeOverDriveHold() — Method in class OverdriveConnector

Places a hold on an item within OverDrive

OverdriveConnector::putCachedData() — Method in class OverdriveConnector

Helper function for storing cached data.

PluginManagerClass in namespace VuFind\DoiLinker

DOI linker plugin manager

PasswordSecurityClass in namespace VuFind\Exception

Password Security Exception

Export::processGroup() — Method in class Export

Convert an array of individual records into a single string for display.

FavoritesService::persistToCache() — Method in class FavoritesService

Persist a resource to the record cache (if applicable).

Form::parseConfig() — Method in class Form

Parse form configuration.

PluginFactoryClass in namespace VuFind\Form\Handler

Form handler plugin factory

PluginManagerClass in namespace VuFind\Form\Handler

Form handler plugin manager

PluginManagerClass in namespace VuFind\Hierarchy\Driver

Hierarchy driver plugin manager

AbstractBase::pickTitle() — Method in class AbstractBase

Choose a title for the record.

PluginManagerClass in namespace VuFind\Hierarchy\TreeDataFormatter

Hierarchy tree data formatter plugin manager

PluginManagerClass in namespace VuFind\Hierarchy\TreeDataSource

Hierarchy tree data source plugin manager

PluginManagerClass in namespace VuFind\Hierarchy\TreeRenderer

Hierarchy tree renderer plugin manager

LocaleSettings::parseDefaultLocale() — Method in class LocaleSettings

Extract and validate default locale from configuration.

LocaleSettings::parseFallbackLocales() — Method in class LocaleSettings

Parses the configured language fallbacks.

LocaleSettings::parseRightToLeftLocales() — Method in class LocaleSettings

Parses the right-to-left language configuration.

$ ExtendedIni#pathStackProperty in class ExtendedIni

List of directories to search for language files.

AbstractAPI::preRequest() — Method in class AbstractAPI

Allow default corrections to all requests

$ Aleph#preferredPickUpLocationsProperty in class Aleph

Preferred pickup locations

Aleph::parseId() — Method in class Aleph

Convert an ID string into an array of bibliographic base and ID within the base.

Aleph::patronLogin() — Method in class Aleph

Patron Login

Aleph::placeHold() — Method in class Aleph

Place Hold

Aleph::parseDate() — Method in class Aleph

Parse a date.

AlephTranslator::parsetable() — Method in class AlephTranslator

Parse a table

Alma::patronLogin() — Method in class Alma

Patron Login

Alma::placeHold() — Method in class Alma

Place a hold request via Alma API. This could be a title level request or an item level request.

Alma::parseDate() — Method in class Alma

Parse a date.

Amicus::pickStatus() — Method in class Amicus

Support method to pick which status message to display when multiple options are present.

Amicus::patronLogin() — Method in class Amicus

Patron Login

DAIA::parseDaiaDoc() — Method in class DAIA

Parse a DAIA document depending on its type.

DAIA::parseDaiaArray() — Method in class DAIA

Parse an array with DAIA status information.

Demo::patronLogin() — Method in class Demo

Patron Login

Demo::placeHold() — Method in class Demo

Place Hold

Demo::placeStorageRetrievalRequest() — Method in class Demo

Place a Storage Retrieval Request

Demo::placeILLRequest() — Method in class Demo

Place ILL Request

Evergreen::patronLogin() — Method in class Evergreen

Patron Login

Folio::preRequest() — Method in class Folio

(From AbstractAPI) Allow default corrections to all requests

Folio::patronLoginWithOkapi() — Method in class Folio

Support method for patronLogin(): authenticate the patron with an Okapi login attempt. Returns a CQL query for retrieving more information about the authenticated user.

Folio::patronLogin() — Method in class Folio

Patron Login

Folio::placeHold() — Method in class Folio

Place Hold

GeniePlus::patronLogin() — Method in class GeniePlus

Patron Login

Horizon::parseStatus() — Method in class Horizon

Protected support method determine availability, reserve and duedate values based on item status. Used by getHolding, getStatus and getStatuses.

Horizon::processHoldingRow() — Method in class Horizon

Protected support method for getHolding.

Horizon::processStatusRow() — Method in class Horizon

Protected support method for getStatuses.

Horizon::patronLogin() — Method in class Horizon

Patron Login

Horizon::processHoldsRow() — Method in class Horizon

Protected support method for getMyHolds.

Horizon::processTransactionsRow() — Method in class Horizon

Protected support method for getMyTransactions.

HorizonXMLAPI::processHoldingRow() — Method in class HorizonXMLAPI

Protected support method for getHolding.

HorizonXMLAPI::processTransactionsRow() — Method in class HorizonXMLAPI

Protected support method for getMyTransactions.

HorizonXMLAPI::placeRequest() — Method in class HorizonXMLAPI

Place Request

HorizonXMLAPI::placeHold() — Method in class HorizonXMLAPI

Place Hold

HorizonXMLAPI::processRenewals() — Method in class HorizonXMLAPI

Process Renewals

Innovative::prepID() — Method in class Innovative

Prepare ID

Innovative::patronLogin() — Method in class Innovative

Patron Login

Koha::patronLogin() — Method in class Koha

Patron Login

$ KohaILSDI#pickupEnableBranchcodesProperty in class KohaILSDI

Codes of locations available for pickup

KohaILSDI::placeHold() — Method in class KohaILSDI

Place Hold

KohaILSDI::patronLogin() — Method in class KohaILSDI

Patron Login

$ KohaRest#permanentRenewalBlocksProperty in class KohaRest

Permanent renewal blocks

$ KohaRest#patronStatusMappingsProperty in class KohaRest

Patron status mappings

KohaRest::patronLogin() — Method in class KohaRest

Patron Login

KohaRest::placeHold() — Method in class KohaRest

Place Hold

KohaRest::placeStorageRetrievalRequest() — Method in class KohaRest

Place Storage Retrieval Request (Call Slip)

KohaRest::pickStatus() — Method in class KohaRest

Protected support method to pick which status message to display when multiple options are present.

KohaRest::pickUpLocationIsValid() — Method in class KohaRest

Is the selected pickup location valid for the hold?

MultiBackend::placeHold() — Method in class MultiBackend

Place Hold

MultiBackend::placeStorageRetrievalRequest() — Method in class MultiBackend

Place Storage Retrieval Request

MultiBackend::placeILLRequest() — Method in class MultiBackend

Place ILL Request

NewGenLib::patronLogin() — Method in class NewGenLib

Patron Login

NoILS::patronLogin() — Method in class NoILS

Patron Login

PAIAClass in namespace VuFind\ILS\Driver

PAIA ILS Driver for VuFind to get patron information

$ PAIA#paiaURLProperty in class PAIA

URL of PAIA service

$ PAIA#paiaTimeoutProperty in class PAIA

Timeout in seconds to be used for PAIA http requests

$ PAIA#paiaCacheEnabledProperty in class PAIA

Flag to switch on/off caching for PAIA items

PAIA::placeILLRequest() — Method in class PAIA

Place ILL Request

PAIA::patronLogin() — Method in class PAIA

Patron Login

PAIA::paiaHandleErrors() — Method in class PAIA

Handle PAIA request errors and throw appropriate exception.

PAIA::placeHold() — Method in class PAIA

Place Hold

PAIA::placeStorageRetrievalRequest() — Method in class PAIA

Place a Storage Retrieval Request

PAIA::paiaStatusString() — Method in class PAIA

PAIA support method to return strings for PAIA service status values

PAIA::paiaGetItems() — Method in class PAIA

PAIA support method for PAIA core method 'items' returning only those documents containing the given service status.

PAIA::paiaParseUserDetails() — Method in class PAIA

PAIA support function to implement ILS specific parsing of user_details

PAIA::paiaPostRequest() — Method in class PAIA

Post something to a foreign host

PAIA::paiaGetRequest() — Method in class PAIA

GET data from foreign host

PAIA::paiaParseJsonAsArray() — Method in class PAIA

Helper function for PAIA to uniformely parse JSON

PAIA::paiaGetAsArray() — Method in class PAIA

Retrieve file at given URL and return it as json_decoded array

PAIA::paiaPostAsArray() — Method in class PAIA

Post something at given URL and return it as json_decoded array

PAIA::paiaLogin() — Method in class PAIA

PAIA authentication function

PAIA::paiaGetUserDetails() — Method in class PAIA

Support method for paiaLogin() -- load user details into session and return array of basic user data.

PAIA::paiaCheckScope() — Method in class PAIA

Checks if the current scope is set for active session.

PAIA::paiaGetSystemMessages() — Method in class PAIA

PAIA support method for PAIA core method 'notifications'

PAIA::paiaRemoveSystemMessage() — Method in class PAIA

PAIA support method for PAIA core method DELETE 'notifications'

PAIA::paiaRemoveSystemMessages() — Method in class PAIA

Removes multiple System Messages. Bulk deletion is not implemented in PAIA, so this method iterates over the set of IDs and removes them separately

PAIA::paiaDeleteRequest() — Method in class PAIA

DELETE data on foreign host

PAIAFactoryClass in namespace VuFind\ILS\Driver

Factory for PAIA ILS driver.

PluginFactoryClass in namespace VuFind\ILS\Driver

ILS driver plugin factory

PluginManagerClass in namespace VuFind\ILS\Driver

ILS driver plugin manager

PolarisClass in namespace VuFind\ILS\Driver

VuFind Connector for Polaris

Polaris::placeHold() — Method in class Polaris

Place Hold

Polaris::patronLogin() — Method in class Polaris

Patron Login

Sample::patronLogin() — Method in class Sample

Patron Login

Sierra::processCallNumber() — Method in class Sierra

Some call number processing used for both getStatus and getHoldings

SierraRest::patronLogin() — Method in class SierraRest

Patron Login

SierraRest::placeHold() — Method in class SierraRest

Place Hold

SierraRest::pickupLocationSortFunction() — Method in class SierraRest

Pickup location sort function

SierraRest::pickUpLocationIsValid() — Method in class SierraRest

Is the selected pickup location valid for the hold?

$ Symphony#policyCacheProperty in class Symphony

Cache for policy information

$ Symphony#policiesProperty in class Symphony

Policy information

Symphony::parseCallInfo() — Method in class Symphony

Parse Call Info

Symphony::parseBoundwithLinkInfo() — Method in class Symphony

Parse Bound With Link Info

Symphony::parseTitleOrderInfo() — Method in class Symphony

Parse Title Order Info

Symphony::parseMarcHoldingsInfo() — Method in class Symphony

Parse MarcHoldingInfo into VuFind items.

Symphony::patronLogin() — Method in class Symphony

Patron Login

Symphony::placeHold() — Method in class Symphony

Place Hold

$ Unicorn#portProperty in class Unicorn
Port
Unicorn::placeHold() — Method in class Unicorn

Place Hold

Unicorn::patronLogin() — Method in class Unicorn

Patron Login

Unicorn::parseStatusLine() — Method in class Unicorn

Parse a pipe-delimited status line received from the script on the Unicorn/Symphony server.

Unicorn::parseDateTime() — Method in class Unicorn

Take a date/time string from SIRSI seltool and convert it into unix time stamp.

Unicorn::processMarcHoldingLocation() — Method in class Unicorn

Given a location field, return the values relevant to VuFind.

Virtua::patronLogin() — Method in class Virtua

Patron Login

Virtua::placeHold() — Method in class Virtua

Place Hold

Voyager::pickStatus() — Method in class Voyager

Protected support method to pick which status message to display when multiple options are present.

Voyager::processStatusData() — Method in class Voyager

Protected support method for getStatus -- process all details collected by getStatusData().

Voyager::processRecordSegment() — Method in class Voyager

Protected support method for getHolding.

Voyager::processHoldingRow() — Method in class Voyager

Protected support method for getHolding.

Voyager::processHoldingDueDate() — Method in class Voyager

Support method for processHoldingData: format a due date for inclusion in holdings data.

Voyager::processHoldingReturnDate() — Method in class Voyager

Support method for processHoldingData: format a return date for inclusion in holdings data.

Voyager::processHoldingData() — Method in class Voyager

Protected support method for getHolding.

Voyager::patronLogin() — Method in class Voyager

Patron Login

Voyager::pickTransactionStatus() — Method in class Voyager

Pick a transaction status worth displaying to the user (or return false if nothing important is found).

Voyager::processMyTransactionsData() — Method in class Voyager

Protected support method for getMyTransactions.

Voyager::processFinesData() — Method in class Voyager

Protected support method for getMyFines.

Voyager::processMyHoldsData() — Method in class Voyager

Protected support method for getMyHolds.

Voyager::processHoldsList() — Method in class Voyager

Process Holds List

Voyager::processMyStorageRetrievalRequestsData() — Method in class Voyager

Protected support method for getMyStorageRetrievalRequests.

$ VoyagerRestful#pickupLocationsInRequestGroupProperty in class VoyagerRestful

Whether pickup location must belong to the request group

VoyagerRestful::processHoldingRow() — Method in class VoyagerRestful

Protected support method for getHolding.

VoyagerRestful::processHoldingData() — Method in class VoyagerRestful

Protected support method for getHolding.

VoyagerRestful::processMyTransactionsData() — Method in class VoyagerRestful

Protected support method for getMyTransactions.

VoyagerRestful::pickUpLocationIsValid() — Method in class VoyagerRestful

Is the selected pickup location valid for the hold?

VoyagerRestful::processMyHoldsData() — Method in class VoyagerRestful

Protected support method for getMyHolds.

VoyagerRestful::placeHold() — Method in class VoyagerRestful

Place Hold

VoyagerRestful::placeStorageRetrievalRequest() — Method in class VoyagerRestful

Place Storage Retrieval Request (Call Slip)

VoyagerRestful::placeILLRequest() — Method in class VoyagerRestful

Place ILL (UB) Request

$ XCNCIP2#pickupLocationsProperty in class XCNCIP2

Pickup locations

$ XCNCIP2#pathResolverProperty in class XCNCIP2

Config file path resolver

$ XCNCIP2#passwordProperty in class XCNCIP2

HTTP Basic password

XCNCIP2::patronLogin() — Method in class XCNCIP2

Patron Login

XCNCIP2::placeStorageRetrievalRequest() — Method in class XCNCIP2

Place Storage Retrieval Request (Call Slip)

XCNCIP2::placeHold() — Method in class XCNCIP2

Place Hold

XCNCIP2::placeRequest() — Method in class XCNCIP2

Place a general request

XCNCIP2::parseXml() — Method in class XCNCIP2

Parse http response into XML object representation

XCNCIP2::parseProblem() — Method in class XCNCIP2

Parse all reported problem and return its string representation

XCNCIP2::parseLocationInstance() — Method in class XCNCIP2

Parse the LocationNameInstanceElement for multi-level locations

Holds::processStorageRetrievalRequests() — Method in class Holds

Process storage retrieval request information in holdings and set the links accordingly.

Holds::processILLRequests() — Method in class Holds

Process ILL request information in holdings and set the links accordingly.

PaginationHelperClass in namespace VuFind\ILS

ILS Pagination Helper

PostClass in namespace VuFind\Log\Writer

This class extends the Laminas Logging to sent POST messages over HTTP

PRISMClass in namespace VuFind\MetadataVocabulary

Metadata vocabulary implementation for PRISM

PluginFactoryClass in namespace VuFind\MetadataVocabulary

Metadata vocabulary plugin factory

PluginManagerClass in namespace VuFind\MetadataVocabulary

Metadata vocabulary plugin manager

$ Server#paramsProperty in class Server

Incoming request parameters

$ Server#pageSizeProperty in class Server

Records per page in lists

Server::prefixID() — Method in class Server

Prepend the OAI prefix to the provided ID number.

AbstractTokenRepository::persistNew() — Method in class AbstractTokenRepository

Persist a token in the database

AccessTokenRepository::persistNewAccessToken() — Method in class AccessTokenRepository

Persists a new access token to permanent storage.

AuthCodeRepository::persistNewAuthCode() — Method in class AuthCodeRepository

Persists a new authentication code to permanent storage.

RefreshTokenRepository::persistNewRefreshToken() — Method in class RefreshTokenRepository

Persists a new refresh token to permanent storage.

AbstractFacets::process() — Method in class AbstractFacets

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

AbstractResultsPassthrough::process() — Method in class AbstractResultsPassthrough

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

AbstractSummonRecommend::process() — Method in class AbstractSummonRecommend

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

$ AbstractSummonRecommendDeferred#processedParamsProperty in class AbstractSummonRecommendDeferred

Configuration parameters processed for submission via AJAX

$ AbstractSummonRecommendDeferred#paramCountProperty in class AbstractSummonRecommendDeferred

Number of expected module parameters (from .ini config)

AbstractSummonRecommendDeferred::process() — Method in class AbstractSummonRecommendDeferred

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

AlphaBrowseLink::process() — Method in class AlphaBrowseLink

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

AuthorFacets::process() — Method in class AuthorFacets

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

AuthorInfo::process() — Method in class AuthorInfo

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

AuthorityRecommend::performSearch() — Method in class AuthorityRecommend

Perform a search of the authority index.

AuthorityRecommend::process() — Method in class AuthorityRecommend

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

$ DOI#prefixProperty in class DOI

URL prefix for resolving DOIs

DOI::process() — Method in class DOI

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

DPLATerms::process() — Method in class DPLATerms

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

DPLATerms::processResults() — Method in class DPLATerms

Process the API response.

Deprecated::process() — Method in class Deprecated

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

$ EDSResultsDeferred#processedParamsProperty in class EDSResultsDeferred

Configuration parameters processed for submission via AJAX

EDSResultsDeferred::process() — Method in class EDSResultsDeferred

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

EuropeanaResults::process() — Method in class EuropeanaResults

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

$ EuropeanaResultsDeferred#processedParamsProperty in class EuropeanaResultsDeferred

Configuration parameters processed for submission via AJAX

EuropeanaResultsDeferred::process() — Method in class EuropeanaResultsDeferred

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

ExpandFacets::process() — Method in class ExpandFacets

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

ExternalSearch::process() — Method in class ExternalSearch

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

Libraryh3lp::process() — Method in class Libraryh3lp

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

MapSelection::process() — Method in class MapSelection
Process
$ OpenLibrarySubjects#pubFilterProperty in class OpenLibrarySubjects

Field to use for date filtering

$ OpenLibrarySubjects#publishedInProperty in class OpenLibrarySubjects

Date filter to apply

OpenLibrarySubjects::process() — Method in class OpenLibrarySubjects

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

$ OpenLibrarySubjectsDeferred#processedParamsProperty in class OpenLibrarySubjectsDeferred

Processed configuration string

OpenLibrarySubjectsDeferred::process() — Method in class OpenLibrarySubjectsDeferred

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

PluginFactoryClass in namespace VuFind\Recommend

Recommendation module plugin factory

PluginManagerClass in namespace VuFind\Recommend

Recommendation module plugin manager

PubDateVisAjaxClass in namespace VuFind\Recommend

PubDateVisAjax Recommendations Module

PubDateVisAjax::process() — Method in class PubDateVisAjax

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

PubDateVisAjax::processDateFacets() — Method in class PubDateVisAjax

Support method for getVisData() -- extract details from applied filters.

$ RandomRecommend#paramManagerProperty in class RandomRecommend

Params manager

RandomRecommend::process() — Method in class RandomRecommend

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

RecommendInterface::process() — Method in class RecommendInterface

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

RecommendLinks::process() — Method in class RecommendLinks

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

RemoveFilters::process() — Method in class RemoveFilters

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

SearchObject::process() — Method in class SearchObject

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

SwitchQuery::process() — Method in class SwitchQuery

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

SwitchTab::process() — Method in class SwitchTab

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

SwitchType::process() — Method in class SwitchType

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

WorldCatIdentities::process() — Method in class WorldCatIdentities

Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.

$ EDS#pdfTypesProperty in class EDS

Document types that are treated as PDF links.

PreviousUniqueIdInterfaceClass in namespace VuFind\RecordDriver\Feature

Interface to support "previous unique ID" behavior.

PreviousUniqueIdTraitClass in namespace VuFind\RecordDriver\Feature

Functionality to implement "previous unique ID" behavior.

$ PreviousUniqueIdTrait#previousUniqueIdProperty in class PreviousUniqueIdTrait

Previous unique ID (if applicable).

Pazpar2Class in namespace VuFind\RecordDriver

Model for Pazpar2 records.

$ Pazpar2#pz2fieldsProperty in class Pazpar2

Pazpar2 fields

PluginFactoryClass in namespace VuFind\RecordDriver

Record driver plugin factory

PluginManagerClass in namespace VuFind\RecordDriver

Record driver plugin manager

PrimoClass in namespace VuFind\RecordDriver

Model for Primo Central records.

PublicationDetailsClass in namespace VuFind\RecordDriver\Response

Class encapsulating publication details.

$ PublicationDetails#placeProperty in class PublicationDetails

Place of publication

$ SolrDefault#preferredSnippetFieldsProperty in class SolrDefault

These Solr fields should be used for snippets if available (listed in order of preference).

$ Map#pathResolverProperty in class Map

Configuration file path resolver

PluginFactoryClass in namespace VuFind\RecordTab

Record tab plugin factory

PluginManagerClass in namespace VuFind\RecordTab

Record tab plugin manager

PreviewClass in namespace VuFind\RecordTab

Embedded Preview tab

PreviewFactoryClass in namespace VuFind\RecordTab

Factory for building the Preview tab.

$ TabManager#pluginManagerProperty in class TabManager

RecordTab plugin manager

PluginManagerClass in namespace VuFind\Record\FallbackLoader

Record fallback loader plugin manager

PluginFactoryClass in namespace VuFind\Related

Related record plugin factory

PluginManagerClass in namespace VuFind\Related

Related record plugin manager

Alma::parseLinks() — Method in class Alma

Parse Links

Demo::parseLinks() — Method in class Demo

Parse Links

DriverInterface::parseLinks() — Method in class DriverInterface

Parse Links

Generic::parseLinks() — Method in class Generic

Parse Links

Jop::parseLinks() — Method in class Jop

Parse Links

PluginFactoryClass in namespace VuFind\Resolver\Driver

Resolver driver plugin factory

PluginManagerClass in namespace VuFind\Resolver\Driver

Resolver driver plugin manager

Redi::parseLinks() — Method in class Redi

Parse Links

Redi::parseDOI() — Method in class Redi

Parse the Redi XML response and return array with DOI information.

Redi::parseRediInfo() — Method in class Redi

Parse Redi additional information elements and return the one identified by the infoToken provided (e.g. "*")

Redi::parseRediOpenURLs() — Method in class Redi

Parse if the Redi xml snippet contains Redi urls.

Redi::postProcessing() — Method in class Redi

Hook for post processing of the parsed resolver response (e.g. by removing any double angle quotation mark from each link['title']).

Sfx::parseLinks() — Method in class Sfx

Parse Links

Threesixtylink::parseLinks() — Method in class Threesixtylink

Parse Links

DynamicRoleProvider::populateRoles() — Method in class DynamicRoleProvider

Populate the internal role array.

DynamicRoleProviderFactory::permissionDefined() — Method in class DynamicRoleProviderFactory

Is the specified permission already defined in the provided configuration?

PermissionDeniedManagerClass in namespace VuFind\Role

Permission Manager

PermissionDeniedManager::processConfigString() — Method in class PermissionDeniedManager

Translate a configuration string into an array.

PermissionDeniedManagerFactoryClass in namespace VuFind\Role

Permission denied manager factory.

PermissionManagerClass in namespace VuFind\Role

Permission Manager

PermissionManager::permissionRuleExists() — Method in class PermissionManager

Check if a permission rule exists for a given context

PermissionManagerFactoryClass in namespace VuFind\Role

Permission manager factory.

PermissionProviderInterfaceClass in namespace VuFind\Role\PermissionProvider

Permission provider interface

PluginManagerClass in namespace VuFind\Role\PermissionProvider

Permission provider plugin manager

HideFacetValueListener::processHideFacetValue() — Method in class HideFacetValueListener

Process hide facet value

$ Options#processedDelimitedFacetsProperty in class Options

Convenient field => delimiter lookup array derived from $delimitedFacets.

ParamsClass in namespace VuFind\Search\Base

Abstract parameters search model.

$ Params#pageProperty in class Params

Page number

Params::parseFilter() — Method in class Params

Parse apart the field and value from a URL filter string.

Params::parseFilterAndPrefix() — Method in class Params

Parse apart any prefix, field and value from a URL filter string.

Params::parseOperatorAndFieldName() — Method in class Params

Parse the operator and field name from a prefixed field string.

$ Results#paramsProperty in class Results

Search parameters

Results::performAndProcessSearch() — Method in class Results

Actually execute the search.

Results::performSearch() — Method in class Results

Abstract support method for performAndProcessSearch -- perform a search based on the parameters passed to the object. This method is responsible for filling in all of the key class properties: results, resultTotal, etc.

ParamsClass in namespace VuFind\Search\Blender

Blender Search Parameters

Params::proxyMethod() — Method in class Params

Proxy a method call to parent class and all backend params classes

ParamsFactoryClass in namespace VuFind\Search\Blender

Factory for Solr search params objects.

Results::performSearch() — Method in class Results

Support method for performAndProcessSearch -- perform a search based on the parameters passed to the object.

ParamsClass in namespace VuFind\Search\BrowZine

BrowZine Search Parameters

Results::performSearch() — Method in class Results

Abstract support method for performAndProcessSearch -- perform a search based on the parameters passed to the object. This method is responsible for filling in all of the key class properties: results, resultTotal, etc.

ParamsClass in namespace VuFind\Search\Combined

Combined Search Parameters

Results::performSearch() — Method in class Results

Abstract support method for performAndProcessSearch -- perform a search based on the parameters passed to the object. This method is responsible for filling in all of the key class properties: results, resultTotal, etc.

Options::populateSearchCriteria() — Method in class Options

Populate available search criteria from the EDS API Info method

Options::populateLimiterValues() — Method in class Options

Populate limiter values from the EDS API INFO method data

Options::populateViewSettings() — Method in class Options

Sets the view settings from EDS API info method call data

ParamsClass in namespace VuFind\Search\EDS

EDS API Params

Results::performSearch() — Method in class Results

Support method for performAndProcessSearch -- perform a search based on the parameters passed to the object.

ParamsClass in namespace VuFind\Search\EIT

EBSCO Search Parameters

Results::performSearch() — Method in class Results

Support method for performAndProcessSearch -- perform a search based on the parameters passed to the object.

ParamsClass in namespace VuFind\Search\EmptySet

Search EmptySet Parameters

Results::performSearch() — Method in class Results

Support method for constructor -- perform a search based on the parameters passed to the object.

PluginManagerClass in namespace VuFind\Search\FacetCache

Facet cache plugin manager

Pazpar2BackendFactoryClass in namespace VuFind\Search\Factory

Factory for Pazpar2 backends.

PrimoBackendFactoryClass in namespace VuFind\Search\Factory

Factory for Primo Central backends.

$ PrimoBackendFactory#primoConfigProperty in class PrimoBackendFactory

Primo configuration

ParamsClass in namespace VuFind\Search\Favorites

Search Favorites Parameters

Results::performSearch() — Method in class Results

Support method for performAndProcessSearch -- perform a search based on the parameters passed to the object.

History::purgeSearchHistory() — Method in class History

Purge the user's unsaved search history.

ParamsClass in namespace VuFind\Search\LibGuides

LibGuides Search Parameters

Results::performSearch() — Method in class Results

Support method for performAndProcessSearch -- perform a search based on the parameters passed to the object.

Minified::populateClassNames() — Method in class Minified

Support method for deminify -- populate parameter class and results class if missing (for legacy compatibility).

ParamsClass in namespace VuFind\Search\MixedList

Search Mixed List Parameters

Results::performSearch() — Method in class Results

Support method for performAndProcessSearch -- perform a search based on the parameters passed to the object.

PluginFactoryClass in namespace VuFind\Search\Options

Search options plugin factory

PluginManagerClass in namespace VuFind\Search\Options

Search options plugin manager

ParamsFactoryClass in namespace VuFind\Search\Params

Generic factory for search params objects.

PluginFactoryClass in namespace VuFind\Search\Params

Search params plugin factory

PluginManagerClass in namespace VuFind\Search\Params

Search params plugin manager

ParamsClass in namespace VuFind\Search\Pazpar2

Pazpar2 Search Parameters

Results::performSearch() — Method in class Results

Support method for performAndProcessSearch -- perform a search based on the parameters passed to the object.

$ InjectOnCampusListener#permissionHandlerProperty in class InjectOnCampusListener

Primo Permission Handler.

ParamsClass in namespace VuFind\Search\Primo

Primo Central Search Parameters

PrimoPermissionHandlerClass in namespace VuFind\Search\Primo

Primo Permission Handler.

$ PrimoPermissionHandler#primoConfigProperty in class PrimoPermissionHandler

Primo-Config for Institutions.

Results::performSearch() — Method in class Results

Support method for performAndProcessSearch -- perform a search based on the parameters passed to the object.

$ RecommendListener#pluginManagerProperty in class RecommendListener

Recommendation module plugin manager.

PluginFactoryClass in namespace VuFind\Search\Results

Search results plugin factory

PluginManagerClass in namespace VuFind\Search\Results

Search results plugin manager

ParamsClass in namespace VuFind\Search\Search2Collection

Search2 Collection Search Options

ParamsClass in namespace VuFind\Search\Search2

Search Params for second Solr index

$ SearchTabsHelper#permissionConfigProperty in class SearchTabsHelper

Tab permission configuration

SearchTabsHelper::parseFilters() — Method in class SearchTabsHelper

Parse a simple filter array to a keyed array

ParamsClass in namespace VuFind\Search\SolrAuth

Solr Authority Search Parameters

ParamsClass in namespace VuFind\Search\SolrAuthorFacets

AuthorFacets Search Parameters

Results::performSearch() — Method in class Results

Support method for performAndProcessSearch -- perform a search based on the parameters passed to the object.

ParamsClass in namespace VuFind\Search\SolrAuthor

Author Search Options

ParamsClass in namespace VuFind\Search\SolrCollection

Solr Collection Search Options

ParamsClass in namespace VuFind\Search\SolrReserves

Solr Reserves Search Parameters

ParamsClass in namespace VuFind\Search\SolrWeb

Solr Web Search Parameters

HierarchicalFacetListener::processHierarchicalFacets() — Method in class HierarchicalFacetListener

Process hierarchical facets and format them accordingly

ParamsClass in namespace VuFind\Search\Solr

Solr Search Parameters

$ Params#pivotFacetsProperty in class Params

Fields for visual faceting

ParamsFactoryClass in namespace VuFind\Search\Solr

Factory for Solr search params objects.

Results::performSearch() — Method in class Results

Support method for performAndProcessSearch -- perform a search based on the parameters passed to the object.

$ SpellingProcessor#phraseProperty in class SpellingProcessor

Show the full modified search phrase on screen rather then just the suggested word?

SpellingProcessor::processSuggestions() — Method in class SpellingProcessor

Process spelling suggestions.

ParamsClass in namespace VuFind\Search\Summon

Summon Search Parameters

Results::performSearch() — Method in class Results

Support method for performAndProcessSearch -- perform a search based on the parameters passed to the object.

Results::processSpelling() — Method in class Results

Process spelling suggestions from the results object

ParamsClass in namespace VuFind\Search\Tags

Search Tags Parameters

Results::performTagSearch() — Method in class Results

Return resources associated with the user tag query.

Results::performSearch() — Method in class Results

Support method for performAndProcessSearch -- perform a search based on the parameters passed to the object.

UrlQueryHelper::parseFilter() — Method in class UrlQueryHelper

Parse apart the field and value from a URL filter string.

ParamsClass in namespace VuFind\Search\WorldCat

WorldCat Search Parameters

Results::performSearch() — Method in class Results

Support method for performAndProcessSearch -- perform a search based on the parameters passed to the object.

ProxyConfigFactoryClass in namespace VuFind\Service

ProxyManager configuration factory.

$ File#pathProperty in class File

Path to session file

PluginFactoryClass in namespace VuFind\Session

Session handler plugin factory

PluginManagerClass in namespace VuFind\Session

Session handler plugin manager

$ Generator#pluginManagerProperty in class Generator

Generator plugin manager

PluginFactoryClass in namespace VuFind\Sitemap

Sitemap generator plugin factory

PluginManagerClass in namespace VuFind\Sitemap

Sitemap generator plugin manager

$ CursorMarkIdFetcher#prevCursorMarkProperty in class CursorMarkIdFetcher

Previous cursor mark

Utils::parseRange() — Method in class Utils

Parse "from" and "to" values out of a range query (or return false if the query is not a range).

Tags::parse() — Method in class Tags

Parse a user-submitted tag string into an array of separate tags.

$ VuFindHighlighter#proxyUrlProperty in class VuFindHighlighter

Proxy url helper

$ Database#preferredHashLengthProperty in class Database

When using a hash algorithm other than base62, the preferred number of characters to use from the hash in the URL (more may be used for disambiguation when necessary).

PluginManagerClass in namespace VuFind\UrlShortener

URL shortener plugin manager.

Citation::prepareAuthors() — Method in class Citation

The code in this module expects authors in "Last Name, First Name" format.

$ Matomo#paramsProperty in class Matomo

Additional parameters

$ Metadata#pluginManagerProperty in class Metadata

Plugin Manager for vocabularies

PermissionClass in namespace VuFind\View\Helper\Root

Permission helper

$ Permission#permissionDeniedManagerProperty in class Permission

PermissionDenied manager for behavior on denied permissions

$ Permission#permissionManagerProperty in class Permission

Permission manager to decide if a permission has been granted or not

PermissionFactoryClass in namespace VuFind\View\Helper\Root

Permission helper factory.

PiwikClass in namespace VuFind\View\Helper\Root

Piwik Web Analytics view helper

$ Piwik#paramsProperty in class Piwik

Additional parameters

PiwikFactoryClass in namespace VuFind\View\Helper\Root

Piwik helper factory.

PrintmsClass in namespace VuFind\View\Helper\Root

Prints a human readable format from a number of milliseconds

ProxyUrlClass in namespace VuFind\View\Helper\Root

Proxy URL view helper

ProxyUrlFactoryClass in namespace VuFind\View\Helper\Root

ProxyUrl helper factory.

$ Related#pluginManagerProperty in class Related

Plugin manager for related record modules.

$ SearchBox#placeholdersProperty in class SearchBox

Placeholders from config.ini

VuFindGeo::parseCoverage() — Method in class VuFindGeo

Parse a dc:coverage string into a key/value array.

ProcessorClass in namespace VuFind\XSLT

VuFind XSLT wrapper

Processor::process() — Method in class Processor

Perform an XSLT transformation and return the results.

Q

$ RecommendOtherPortals#queryProperty in class RecommendOtherPortals

Link to main portal.

SparqlService::query() — Method in class SparqlService

Query Wikidata SPARQL endpoint

$ Backend#queryBuilderProperty in class Backend

Query builder.

QueryBuilderClass in namespace VuFindSearch\Backend\BrowZine

BrowZine QueryBuilder.

$ Backend#queryBuilderProperty in class Backend

Query builder

$ AutocompleteCommand#queryProperty in class AutocompleteCommand

Simple query string.

QueryBuilderClass in namespace VuFindSearch\Backend\EDS

EDS API Querybuilder

QueryBuilder::queryToEdsQuery() — Method in class QueryBuilder

Convert a single Query object to an eds api query array

QueryBuilder::queryGroupToArray() — Method in class QueryBuilder

Convert a QueryGroup object to a query string.

$ SearchRequestModel#queryProperty in class SearchRequestModel

What to search for, formatted as [{boolean operator},][{field code}:]{term}

$ Backend#queryBuilderProperty in class Backend

Query builder.

QueryBuilderClass in namespace VuFindSearch\Backend\EIT

EIT QueryBuilder.

QueryBuilder::queryGroupToString() — Method in class QueryBuilder

Convert a QueryGroup object to a query string.

QueryBuilder::queryToString() — Method in class QueryBuilder

Convert a single Query object to a query string.

$ Backend#queryBuilderProperty in class Backend

Query builder.

Connector::query() — Method in class Connector

Execute a search. adds all the querystring parameters into $this->client and returns the parsed response

QueryBuilderClass in namespace VuFindSearch\Backend\LibGuides

LibGuides QueryBuilder.

QueryBuilder::queryGroupToArray() — Method in class QueryBuilder

Convert a QueryGroup object to a query string.

QueryBuilder::queryToArray() — Method in class QueryBuilder

Convert a single Query object to a query string.

$ Backend#queryBuilderProperty in class Backend

Query builder.

Connector::query() — Method in class Connector

Requests and receives information from pazpar

QueryBuilderClass in namespace VuFindSearch\Backend\Pazpar2

Pazpar2 QueryBuilder.

QueryBuilder::queryGroupToString() — Method in class QueryBuilder

Convert a QueryGroup object to a query string.

QueryBuilder::queryToString() — Method in class QueryBuilder

Convert a single Query object to a query string.

$ Backend#queryBuilderProperty in class Backend

Query builder.

Connector::query() — Method in class Connector

Execute a search. Adds all the querystring parameters into $this->client and returns the parsed response

QueryBuilderClass in namespace VuFindSearch\Backend\Primo

Primo Central QueryBuilder.

QueryBuilder::queryGroupToArray() — Method in class QueryBuilder

Convert a QueryGroup object to a query string.

QueryBuilder::queryToArray() — Method in class QueryBuilder

Convert a single Query object to a query string.

$ Backend#queryBuilderProperty in class Backend

Query builder.

Connector::query() — Method in class Connector

Send query to SOLR and return response body.

$ DeleteDocument#queriesProperty in class DeleteDocument

Delete queries.

QueryBuilderClass in namespace VuFindSearch\Backend\Solr

SOLR QueryBuilder.

QueryBuilderInterfaceClass in namespace VuFindSearch\Backend\Solr

SOLR QueryBuilder interface definition.

$ Spellcheck#queryProperty in class Spellcheck

Spelling query that generated suggestions

$ Backend#queryBuilderProperty in class Backend

Query builder.

QueryBuilderClass in namespace VuFindSearch\Backend\Summon

Summon QueryBuilder.

QueryBuilder::queryGroupToString() — Method in class QueryBuilder

Convert a QueryGroup object to a query string.

QueryBuilder::queryToString() — Method in class QueryBuilder

Convert a single Query object to a query string.

$ Backend#queryBuilderProperty in class Backend

Query builder.

QueryBuilderClass in namespace VuFindSearch\Backend\WorldCat

WorldCat QueryBuilder.

QueryBuilder::queryGroupToString() — Method in class QueryBuilder

Convert a QueryGroup object to a query string.

QueryBuilder::queryToString() — Method in class QueryBuilder

Convert a single Query object to a query string.

QueryOffsetLimitTraitClass in namespace VuFindSearch\Command\Feature

Trait for commands with search query, offset and limit arguments.

$ QueryOffsetLimitTrait#queryProperty in class QueryOffsetLimitTrait

Search query.

$ RandomCommand#queryProperty in class RandomCommand

Search query.

QueryClass in namespace VuFindSearch\Query

A single/simple query.

$ Query#queryHandlerProperty in class Query

Name of query handler, if any.

$ Query#queryStringProperty in class Query

Query string

QueryGroupClass in namespace VuFindSearch\Query

A group of single/simples queries, joined by boolean operator.

$ QueryGroup#queriesProperty in class QueryGroup
Queries.
QueryInterfaceClass in namespace VuFindSearch\Query

Common methods that must be shared by all query objects.

QueryBuilderTestClass in namespace VuFindTest\Backend\BrowZine

Unit tests for BrowZine query builder

QueryBuilderTestClass in namespace VuFindTest\Backend\EDS

Unit tests for EDS query builder

QueryBuilderTestClass in namespace VuFindTest\Backend\EIT

Unit tests for EIT query builder

QueryBuilderTestClass in namespace VuFindTest\Backend\LibGuides

Unit tests for LibGuides query builder

QueryBuilderTestClass in namespace VuFindTest\Backend\Primo

Unit tests for Primo query builder

QueryBuilderTestClass in namespace VuFindTest\Backend\Solr

Unit tests for SOLR query builder

QueryBuilderTestClass in namespace VuFindTest\Backend\Summon

Unit tests for Summon query builder

QueryBuilderTestClass in namespace VuFindTest\Backend\WorldCat

Unit tests for WorldCat query builder

QueryGroupTestClass in namespace VuFindTest\Query

Unit tests for QueryGroup class.

QueryTestClass in namespace VuFindTest\Query

Unit tests for Query class.

QueryAdapterTestClass in namespace VuFindTest\Search

QueryAdapter unit tests.

BrowseController::quoteValues() — Method in class BrowseController

Helper class that adds quotes around the values of an array

DbUpgrade::query() — Method in class DbUpgrade

Execute a query.

QRCodeControllerClass in namespace VuFind\Controller

Generates qrcodes

QRCodeControllerFactoryClass in namespace VuFind\Controller

QRCode controller factory.

$ Aleph#quick_availabilityProperty in class Aleph

If enabled and Xserver is disabled, slower RESTful API is used for availability check.

$ Aleph#queuePositionRegexProperty in class Aleph

Regex for extracting position in queue from status in holdings.

Unicorn::querySirsi() — Method in class Unicorn

Send a request to the SIRSI side API script and returns the response.

$ AlphaBrowseLink#queryProperty in class AlphaBrowseLink

Search query submitted

SwitchQuery::queryShouldBeSkipped() — Method in class SwitchQuery

Should the query be ignored when making recommendations?

$ Params#queryProperty in class Params

Internal representation of user query.

$ Results#queryStartTimeProperty in class Results

Query start time

$ Results#queryEndTimeProperty in class Results

Query end time

$ Results#queryTimeProperty in class Results

Query time (total)

QueryAdapterClass in namespace VuFind\Search\EDS

EDS API Query Adapter: search query parameters to AbstractQuery object

QueryAdapterClass in namespace VuFind\Search

Legacy adapter: search query parameters to AbstractQuery object

$ UrlQueryHelper#queryObjectProperty in class UrlQueryHelper

Current query object

R

$ Search2ApiController#recordRouteProperty in class Search2ApiController

Record route uri

SearchApiController::recordAction() — Method in class SearchApiController

Record action

$ ExpireCsrfTokensCommand#rowLabelProperty in class ExpireCsrfTokensCommand

Label to use for rows in help messages.

$ ExpireUsersCommand#rowLabelProperty in class ExpireUsersCommand

Label to use for rows in help messages.

$ UpdateResourcesFromSolrCommand#resourceTableProperty in class UpdateResourcesFromSolrCommand

Help description for the command.

$ UpdateResourcesFromSolrCommand#recordLoaderProperty in class UpdateResourcesFromSolrCommand

Help description for the command.

Cronjob::runCommand() — Method in class Cronjob

Run console command

$ XCNCIP2Test#renewMyItemsTestsProperty in class XCNCIP2Test
$ XCNCIP2Test#requestTestsProperty in class XCNCIP2Test
$ XCNCIP2Test#renewMyItemsWithDisabledRenewalsProperty in class XCNCIP2Test
$ GetHolding#recordLinkerProperty in class GetHolding

Record link helper

$ GetLibrariesACSuggestions#resultsManagerProperty in class GetLibrariesACSuggestions
ResultsManager
$ GetObalkyKnihCoverWithoutSolr#rendererProperty in class GetObalkyKnihCoverWithoutSolr

PHP renderer

$ HarvestWidgetsContents#resourceProperty in class HarvestWidgetsContents

User resource table

$ Manager#restorerProperty in class Manager

Restorer to load saved user settings to sesssion

$ SolrAuthorityEnricher#recordLinkerProperty in class SolrAuthorityEnricher

Record link helper

$ SolrAuthorityEnricher#rendererProperty in class SolrAuthorityEnricher
Renderer
$ SolrAuthorityEnricher#recordIdFieldProperty in class SolrAuthorityEnricher

Solr record id

$ SolrPrefixHandler#resultsManagerProperty in class SolrPrefixHandler

Results manager

$ SolrPrefixSorted#resultsManagerProperty in class SolrPrefixSorted

Results manager

$ AbstractDbAwaredRecordIds#recordLoaderProperty in class AbstractDbAwaredRecordIds

Record loader

$ InvolvedLibrariesService#resultsManagerProperty in class InvolvedLibrariesService

Results manager

FlashRedirect::restore() — Method in class FlashRedirect

Restore messages in flashMessenger from parameters in URL

Holds::rememberValidId() — Method in class Holds

Add an ID to the validation array.

ResultScrollerClass in namespace KnihovnyCz\Controller\Plugin

Class for managing "next" and "previous" navigation within result sets.

$ ResultScroller#rendererProperty in class ResultScroller
Renderer
ResultScroller::restoreLastSearch() — Method in class ResultScroller

Return the last saved search.

ResultScrollerFactoryClass in namespace KnihovnyCz\Controller\Plugin

Factory for ResultScroller controller plugin.

RecordControllerClass in namespace KnihovnyCz\Controller

Class RecordController

$ RecordController#redirectToLibraryProperty in class RecordController

Redirect library records to library record controller?

RecordController::redirectToLocalRecordAction() — Method in class RecordController

Redirect to local record

ResourceClass in namespace KnihovnyCz\Db\Row

Class Resource

ResourceClass in namespace KnihovnyCz\Db\Table

Class Resource

$ KohaRest1905#renewalBlockMappingsProperty in class KohaRest1905

Mappings from renewal block reasons

KohaRest1905::renewMyItems() — Method in class KohaRest1905

Renew My Items

MultiBackend::resolveIds() — Method in class MultiBackend

Resolve identifiers

XCNCIP2::registerNamespaceFor() — Method in class XCNCIP2

Register namespace(s) for an XML element/tree

SolrIdResolver::resolveIds() — Method in class SolrIdResolver

Resolve id in solr using item identifiers

InvolvedLibrariesBuilder::replacePlaceholders() — Method in class InvolvedLibrariesBuilder

Replace placeholder with generated node tree

InvolvedLibrariesExtension::register() — Method in class InvolvedLibrariesExtension

Register extension

InvolvedLibrariesRenderer::render() — Method in class InvolvedLibrariesRenderer

Render node

RecommendOtherPortalsClass in namespace KnihovnyCz\Recommend

RecommendOtherPortals Recommendations Module

PatentTrait::renderPatentInfo() — Method in class PatentTrait

Render patent info to export file

$ SolrAuthority#recordDataFormatterKeyProperty in class SolrAuthority

Record data formatter key

$ SolrAuthority#recordDataTypeDescriptionProperty in class SolrAuthority

Record data description

$ SolrDefault#recordDataFormatterKeyProperty in class SolrDefault

Record data formatter key

$ SolrDefault#recordDataTypeDescriptionProperty in class SolrDefault

Record data description

$ SolrDefault#recordLoaderProperty in class SolrDefault

Record loader

$ SolrDefault#recordFactoryProperty in class SolrDefault

Record factory

$ SolrDictionary#recordDataFormatterKeyProperty in class SolrDictionary

Record data formatter key

SolrMarc::remapSiglaForNkp() — Method in class SolrMarc

As we work with all NKP departments as it would be one library, we need to remap some bases to the correct sigla

$ SolrField#resultsProperty in class SolrField

Similar records

RouteGeneratorClass in namespace KnihovnyCz\Route

Class RouteGenerator

$ SolrDefaultBackendFactory#recordCollectionClassProperty in class SolrDefaultBackendFactory

Record collection class for RecordCollectionFactory

SearchRunner::run() — Method in class SearchRunner

Run the search.

$ Connector#requestProperty in class Connector
Request
$ PerformanceLogger#requestProperty in class PerformanceLogger
Request
RecordCollectionClass in namespace KnihovnyCz\Search\Solr\Backend\Response\Json

Simple JSON-based record collection.

ResultsClass in namespace KnihovnyCz\Search\Solr

Results search model.

UrlQueryHelper::removeFilterByField() — Method in class UrlQueryHelper

Remove all filters.

UserSettingsService::restore() — Method in class UserSettingsService

Updates the user information in the session.

NullSessionManager::regenerateId() — Method in class NullSessionManager

Regenerate id

NullSessionManager::rememberMe() — Method in class NullSessionManager

Set the TTL (in seconds) for the session cookie expiry

RecordDataFormatterFactoryClass in namespace KnihovnyCz\View\Helper\KnihovnyCz

Class RecordDataFormatterFactory

RecordLinkerClass in namespace KnihovnyCz\View\Helper\KnihovnyCz
RecordLinker
RecordLinkerFactoryClass in namespace KnihovnyCz\View\Helper\KnihovnyCz
RecordLinker
$ Search2ApiController#recordRouteProperty in class Search2ApiController

Record route uri

$ SearchApiController#recordFormatterProperty in class SearchApiController

Record formatter

$ SearchApiController#recordAccessPermissionProperty in class SearchApiController

Permission required for the record endpoint

$ SearchApiController#recordRouteProperty in class SearchApiController

Record route uri

SearchApiController::recordAction() — Method in class SearchApiController

Record action

$ WebApiController#recordRouteProperty in class WebApiController

Record route uri

BaseFormatter::resetArrayIndices() — Method in class BaseFormatter

Reset numerical array indices.

RecordFormatterClass in namespace VuFindApi\Formatter

Record formatter for API responses

$ RecordFormatter#recordFieldsProperty in class RecordFormatter

Record field definitions

RecordFormatterFactoryClass in namespace VuFindApi\Formatter

Record Formatter factory.

$ AbstractRouteCommand#routeGeneratorProperty in class AbstractRouteCommand

Route generator

RecordRouteCommandClass in namespace VuFindConsole\Command\Generate

Console command: Generate record route.

MergeMarcCommand::recordXmlToString() — Method in class MergeMarcCommand

Convert a SimpleXMLElement into a string, ensuring that namespace declarations are appropriately included.

WebCrawlCommand::removeTempFile() — Method in class WebCrawlCommand

Remove a temporary file.

$ AbstractCommand#readerProperty in class AbstractCommand

Reader for .ini files

$ NotifyCommand#rendererProperty in class NotifyCommand

View renderer

$ NotifyCommand#resultsManagerProperty in class NotifyCommand

Search results plugin manager

$ AbstractExpireCommand#rowLabelProperty in class AbstractExpireCommand

Label to use for rows in help messages.

$ CleanUpRecordCacheCommand#recordTableProperty in class CleanUpRecordCacheCommand

Record table object

$ CreateHierarchyTreesCommand#recordLoaderProperty in class CreateHierarchyTreesCommand

Record loader

$ CreateHierarchyTreesCommand#resultsManagerProperty in class CreateHierarchyTreesCommand

Search results manager

$ ExpireAccessTokensCommand#rowLabelProperty in class ExpireAccessTokensCommand

Label to use for rows in help messages.

$ ExpireAuthHashesCommand#rowLabelProperty in class ExpireAuthHashesCommand

Label to use for rows in help messages.

$ ExpireExternalSessionsCommand#rowLabelProperty in class ExpireExternalSessionsCommand

Label to use for rows in help messages.

$ ExpireSearchesCommand#rowLabelProperty in class ExpireSearchesCommand

Label to use for rows in help messages.

$ ExpireSessionsCommand#rowLabelProperty in class ExpireSessionsCommand

Label to use for rows in help messages.

$ IndexReservesCommand#requiredKeysProperty in class IndexReservesCommand

Keys required in the data to create a valid reserves index.

ConsoleRunner::run() — Method in class ConsoleRunner

Run the console action

GeneratorTools::retrieveConfig() — Method in class GeneratorTools

Retrieve a value from the application configuration (or return false if the path is not found).

BackendInterface::retrieve() — Method in class BackendInterface

Retrieve a single document.

Backend::retrieve() — Method in class Backend

Retrieve a single document.

RecordCollectionClass in namespace VuFindSearch\Backend\Blender\Response\Json

JSON-based record collection for records from multiple sources.

Backend::retrieve() — Method in class Backend

Retrieve a single document.

Connector::request() — Method in class Connector

Perform an API request and return the response body

RecordCollectionClass in namespace VuFindSearch\Backend\BrowZine\Response

BrowZine record collection.

$ RecordCollection#responseProperty in class RecordCollection

Raw response.

RecordCollectionFactoryClass in namespace VuFindSearch\Backend\BrowZine\Response

Simple factory for record collection.

$ RecordCollectionFactory#recordFactoryProperty in class RecordCollectionFactory

Factory to turn data into a record object.

Backend::retrieve() — Method in class Backend

Retrieve a single document.

Base::retrieve() — Method in class Base

Retrieves a record specified by its identifiers

RecordCollectionClass in namespace VuFindSearch\Backend\EDS\Response

EDS API record collection.

$ RecordCollection#responseProperty in class RecordCollection

Response from API

RecordCollectionFactoryClass in namespace VuFindSearch\Backend\EDS\Response

Factory for record collection.

$ RecordCollectionFactory#recordFactoryProperty in class RecordCollectionFactory

Factory to turn data into a record object.

$ SearchRequestModel#resultsPerPageProperty in class SearchRequestModel

Number of records to return

Backend::retrieve() — Method in class Backend

Retrieve a single document.

RecordCollectionClass in namespace VuFindSearch\Backend\EIT\Response\XML

EIT record collection.

$ RecordCollection#responseProperty in class RecordCollection

Raw response.

RecordCollectionFactoryClass in namespace VuFindSearch\Backend\EIT\Response\XML

Simple XML-based factory for record collection.

$ RecordCollectionFactory#recordFactoryProperty in class RecordCollectionFactory

Factory to turn data into a record object.

$ HttpErrorException#responseProperty in class HttpErrorException

Server response.

RemoteErrorExceptionClass in namespace VuFindSearch\Backend\Exception
RemoteErrorException.
RequestErrorExceptionClass in namespace VuFindSearch\Backend\Exception
RequestErrorException.
Backend::retrieve() — Method in class Backend

Retrieve a single document.

RecordCollectionClass in namespace VuFindSearch\Backend\LibGuides\Response

WorldCat record collection.

$ RecordCollection#responseProperty in class RecordCollection

Raw response.

RecordCollectionFactoryClass in namespace VuFindSearch\Backend\LibGuides\Response

Simple factory for record collection.

$ RecordCollectionFactory#recordFactoryProperty in class RecordCollectionFactory

Factory to turn data into a record object.

Backend::retrieve() — Method in class Backend

Retrieve a single document.

Connector::record() — Method in class Connector

Retrieves a detailed record.

RecordClass in namespace VuFindSearch\Backend\Pazpar2\Response

Simple Pazpar2 record.

RecordCollectionClass in namespace VuFindSearch\Backend\Pazpar2\Response

Pazpar2 record collection.

$ RecordCollection#responseProperty in class RecordCollection

Raw response.

RecordCollectionFactoryClass in namespace VuFindSearch\Backend\Pazpar2\Response

Simple factory for record collection.

$ RecordCollectionFactory#recordFactoryProperty in class RecordCollectionFactory

Factory to turn data into a record object.

Backend::retrieve() — Method in class Backend

Retrieve a single document.

RecordCollectionClass in namespace VuFindSearch\Backend\Primo\Response

Primo Central record collection.

$ RecordCollection#responseProperty in class RecordCollection

Raw response.

RecordCollectionFactoryClass in namespace VuFindSearch\Backend\Primo\Response

Simple factory for record collection.

$ RecordCollectionFactory#recordFactoryProperty in class RecordCollectionFactory

Factory to turn data into a record object.

$ Connector#rawProperty in class Connector

Whether to Serialize to a PHP Array or not.

Backend::rawJsonSearch() — Method in class Backend

Perform a search and return a raw response.

Backend::random() — Method in class Backend

Get Random records

Backend::retrieve() — Method in class Backend

Retrieve a single document.

Backend::retrieveBatch() — Method in class Backend

Retrieve a batch of documents.

Backend::refineBrowseException() — Method in class Backend

Improve the exception message for alphaBrowse errors when appropriate.

RawJsonSearchCommandClass in namespace VuFindSearch\Backend\Solr\Command

Command to perform a Solr search and return a decoded JSON response free from additional processing.

Connector::retrieve() — Method in class Connector

Return document specified by id.

RawCSVDocumentClass in namespace VuFindSearch\Backend\Solr\Document

SOLR "raw CSV" document class for submitting bulk data.

RawDocumentClass in namespace VuFindSearch\Backend\Solr\Document

SOLR "raw document" class for submitting any type of data.

RawJSONDocumentClass in namespace VuFindSearch\Backend\Solr\Document

SOLR "raw JSON" document class for manual overrides.

RawXMLDocumentClass in namespace VuFindSearch\Backend\Solr\Document

SOLR "raw XML" document class for manual overrides.

$ UpdateDocument#recordsProperty in class UpdateDocument

Records and index attributes.

LuceneSyntaxHelper::removeNonQuoted() — Method in class LuceneSyntaxHelper

Remove occurrences of given characters in non-quoted parts of the string

QueryBuilder::reduceQueryGroup() — Method in class QueryBuilder

Reduce query group a single query.

QueryBuilder::reduceQueryGroupComponents() — Method in class QueryBuilder

Reduce components of query group to a search string of a simple query.

NamedList::rewind() — Method in class NamedList

Rewind iterator.

NamedList::removeKey() — Method in class NamedList

Remove single element from list.

NamedList::removeKeys() — Method in class NamedList

Remove elements from list.

RecordClass in namespace VuFindSearch\Backend\Solr\Response\Json

Simple, schema-less SOLR record.

RecordCollectionClass in namespace VuFindSearch\Backend\Solr\Response\Json

Simple JSON-based record collection.

$ RecordCollection#responseProperty in class RecordCollection

Deserialized SOLR response.

RecordCollectionFactoryClass in namespace VuFindSearch\Backend\Solr\Response\Json

Simple JSON-based factory for record collection.

$ RecordCollectionFactory#recordFactoryProperty in class RecordCollectionFactory

Factory to turn data into a record object.

Backend::retrieve() — Method in class Backend

Retrieve a single document.

Backend::retrieveBatch() — Method in class Backend

Retrieve a batch of documents.

RecordCollectionClass in namespace VuFindSearch\Backend\Summon\Response

WorldCat record collection.

$ RecordCollection#responseProperty in class RecordCollection

Raw response.

RecordCollectionFactoryClass in namespace VuFindSearch\Backend\Summon\Response

Simple factory for record collection.

$ RecordCollectionFactory#recordFactoryProperty in class RecordCollectionFactory

Factory to turn data into a record object.

Backend::retrieve() — Method in class Backend

Retrieve a single document.

RecordClass in namespace VuFindSearch\Backend\WorldCat\Response\XML

Simple WorldCat record.

RecordCollectionClass in namespace VuFindSearch\Backend\WorldCat\Response\XML

WorldCat record collection.

$ RecordCollection#responseProperty in class RecordCollection

Raw response.

RecordCollectionFactoryClass in namespace VuFindSearch\Backend\WorldCat\Response\XML

Simple XML-based factory for record collection.

$ RecordCollectionFactory#recordFactoryProperty in class RecordCollectionFactory

Factory to turn data into a record object.

$ AbstractBase#resultProperty in class AbstractBase

Result of executed operation

RecordIdentifierTraitClass in namespace VuFindSearch\Command\Feature

Trait for commands with a record identifier argument.

RandomCommandClass in namespace VuFindSearch\Command

Return random records command.

RetrieveBatchCommandClass in namespace VuFindSearch\Command

Retrieve a batch of documents command.

RetrieveCommandClass in namespace VuFindSearch\Command

Retrieve a single document command.

RuntimeExceptionClass in namespace VuFindSearch\Exception

Generic RuntimeException.

RandomInterfaceClass in namespace VuFindSearch\Feature

Random record retrieval feature interface definition.

RandomInterface::random() — Method in class RandomInterface

Return random records.

RetrieveBatchInterfaceClass in namespace VuFindSearch\Feature

Optional backend feature: retrieve batch of records.

RetrieveBatchInterface::retrieveBatch() — Method in class RetrieveBatchInterface

Retrieve a batch of documents.

ParamBag::remove() — Method in class ParamBag

Remove a parameter.

ParamBag::request() — Method in class ParamBag

Return array of params ready to be used in a HTTP request.

Query::replaceTerm() — Method in class Query

Replace a term.

$ QueryGroup#reducedHandlerProperty in class QueryGroup

Name of the handler to be used if the query group is reduced.

QueryGroup::replaceTerm() — Method in class QueryGroup

Replace a term.

QueryInterface::replaceTerm() — Method in class QueryInterface

Replace a term.

$ AbstractRecordCollection#recordsProperty in class AbstractRecordCollection

Response records.

AbstractRecordCollection::replace() — Method in class AbstractRecordCollection

Replace a record in the collection.

AbstractRecordCollection::rewind() — Method in class AbstractRecordCollection

Rewind collection index.

RecordCollectionFactoryInterfaceClass in namespace VuFindSearch\Response

Search backend record collection factory interface.

RecordCollectionInterfaceClass in namespace VuFindSearch\Response

Interface for backend responses to a search() operation.

RecordInterfaceClass in namespace VuFindSearch\Response

Record interface.

RecordTraitClass in namespace VuFindSearch\Response

Record trait that implements common interface methods.

Service::resolve() — Method in class Service

Resolve a backend.

CheckRequestIsValidTest::runSuccessfulTest() — Method in class CheckRequestIsValidTest

Generic support function for successful request tests.

RecommendTestClass in namespace VuFindTest\AjaxHandler

Recommend test class.

RecordCollectionFactoryTestClass in namespace VuFindTest\Backend\BrowZine\Response

Unit tests for BrowZine record collection factory.

RecordCollectionTestClass in namespace VuFindTest\Backend\BrowZine\Response

Unit tests for BrowZine record collection

$ ConnectorTest#responseProperty in class ConnectorTest

Current response.

RecordCollectionFactoryTestClass in namespace VuFindTest\Backend\EDS\Response

Unit tests for EDS record collection factory

RecordCollectionTestClass in namespace VuFindTest\Backend\EDS\Response

Unit tests for EDS record collection

RecordCollectionFactoryTestClass in namespace VuFindTest\Backend\EIT\Response\XML

Unit tests for EIT record collection factory.

RecordCollectionTestClass in namespace VuFindTest\Backend\EIT\Response\XML

Unit tests for EIT record collection

RecordCollectionFactoryTestClass in namespace VuFindTest\Backend\LibGuides\Response

Unit tests for LibGuides record collection factory.

RecordCollectionTestClass in namespace VuFindTest\Backend\LibGuides\Response

Unit tests for LibGuides record collection

$ ConnectorTest#responseProperty in class ConnectorTest

Current response.

RecordCollectionFactoryTestClass in namespace VuFindTest\Backend\Primo\Response

Unit tests for Primo record collection factory.

RecordCollectionTestClass in namespace VuFindTest\Backend\Primo\Response

Unit tests for Primo record collection

BackendTest::runRetrieveBatchTests() — Method in class BackendTest

Given a configured backend, run some standard tests (this allows us to test two different versions of the same scenario.

BackendTest::runRefineExceptionCall() — Method in class BackendTest

Support method to run a "refine exception" test.

RawJsonSearchCommandTestClass in namespace VuFindTest\Backend\Solr\Command

Unit tests for RawJsonSearchCommand.

$ ConnectorTest#responseProperty in class ConnectorTest

Current response.

RawCSVDocumentTestClass in namespace VuFindTest\Backend\Solr\Document

Unit tests for SOLR raw CSV document class.

RawJSONDocumentTestClass in namespace VuFindTest\Backend\Solr\Document

Unit tests for SOLR raw JSON document class.

RawXMLDocumentTestClass in namespace VuFindTest\Backend\Solr\Document

Unit tests for SOLR raw XML document class.

RecordCollectionFactoryTestClass in namespace VuFindTest\Backend\Solr\Json\Response

Unit tests for simple JSON-based record collection factory.

RecordCollectionTestClass in namespace VuFindTest\Backend\Solr\Json\Response

Unit tests for simple JSON-based record collection.

QueryBuilderTest::runBasicQuestionTest() — Method in class QueryBuilderTest

Run a test case through a basic query.

QueryBuilderTest::runAdvancedQuestionTest() — Method in class QueryBuilderTest

Run a test case through an advanced query.

QueryBuilderTest::runQuestionTests() — Method in class QueryBuilderTest

Run the standard suite of question mark tests, accounting for differences between stanard Lucene, basic Dismax and eDismax handlers.

RecordCollectionFactoryTestClass in namespace VuFindTest\Backend\Summon\Response

Unit tests for Summon record collection factory

RecordCollectionTestClass in namespace VuFindTest\Backend\Summon\Response

Unit tests for Summon record collection

RecordCollectionFactoryTestClass in namespace VuFindTest\Backend\WorldCat\Response\XML

Unit tests for WorldCat backend.

ImporterTest::runTestModeTest() — Method in class ImporterTest

Run a test in test mode.

RandomTestClass in namespace VuFindTest\ChannelProvider

Random Test Class

RecordRouteCommandTestClass in namespace VuFindTest\Command\Generate

Generate/RecordRoute command test.

RandomCommandTestClass in namespace VuFindTest\Command

Unit tests for RandomCommand.

RetrieveBatchCommandTestClass in namespace VuFindTest\Command

Unit tests for RetrieveBatchCommand.

RetrieveCommandTestClass in namespace VuFindTest\Command

Unit tests for RetrieveCommand.

$ AbstractExpireCommandTest#rowLabelProperty in class AbstractExpireCommandTest

Label to use for rows in help messages.

$ ExpireAuthHashesCommandTest#rowLabelProperty in class ExpireAuthHashesCommandTest

Label to use for rows in help messages.

$ ExpireExternalSessionsCommandTest#rowLabelProperty in class ExpireExternalSessionsCommandTest

Label to use for rows in help messages.

$ ExpireSearchesCommandTest#rowLabelProperty in class ExpireSearchesCommandTest

Label to use for rows in help messages.

$ ExpireSessionsCommandTest#rowLabelProperty in class ExpireSessionsCommandTest

Label to use for rows in help messages.

ResponseFormatterTraitTestClass in namespace VuFindTest\Controller\Feature

Class ResponseFormatterTraitTest

ResultScrollerMockClass in namespace VuFindTest\Controller\Plugin

Mock class to stub search results

ResultScrollerMock::restoreLastSearch() — Method in class ResultScrollerMock
Stubbed
ResultScrollerMock::rememberSearch() — Method in class ResultScrollerMock
Stubbed
ResultScrollerTestClass in namespace VuFindTest\Controller\Plugin

ResultScroller controller plugin tests.

RouterTestClass in namespace VuFindTest\Cover

Cover Router Test Class

$ AutoRetryTrait#retriesLeftProperty in class AutoRetryTrait

Count of remaining retry attempts (updated during the retry loop). This is exposed as a class property rather than a local variable so that classes using the trait can be aware of the retry state. This is used, for example, in the VuFindTest\Integration\MinkTestCase class to control screenshot behavior.

AutoRetryTrait::runBare() — Method in class AutoRetryTrait

Override PHPUnit's main run method, introducing annotation-based retry behavior.

LiveDatabaseTrait::removeUsers() — Method in class LiveDatabaseTrait

Static teardown support function to destroy user accounts. Accounts are expected to exist, and the method will fail if they are missing.

ReflectionTraitClass in namespace VuFindTest\Feature

Reflection helper methods for unit tests.

RecordFormatterTestClass in namespace VuFindTest\Formatter

Unit tests for record formatter.

ILSMockTrait::renewMyItems() — Method in class ILSMockTrait
$ PAIATest#requestsTestResultProperty in class PAIATest
$ PAIATest#renewTestResultProperty in class PAIATest
$ XCNCIP2Test#renewMyItemsTestsProperty in class XCNCIP2Test

Test definition for testRenewMyItems

$ XCNCIP2Test#renewMyItemsWithDisabledRenewalsProperty in class XCNCIP2Test
$ XCNCIP2Test#requestTestsProperty in class XCNCIP2Test

Test definition for testGetRequestMethods

MinkTestCase::restoreConfigs() — Method in class MinkTestCase

Restore configurations to the state they were in prior to a call to changeConfig().

ResultFeedTestClass in namespace VuFindTest\Integration\View\Helper\Root

ResultFeed Test Class

ExampleExtension::register() — Method in class ExampleExtension

Register extension to environment

CartTest::runConfigCombo() — Method in class CartTest
FavoritesTest::removeUsername2() — Method in class FavoritesTest

Retry cleanup method in case of failure during testAddSearchItemToFavoritesNewAccount.

HoldsTest::removeUsername2() — Method in class HoldsTest

Retry cleanup method in case of failure during testHoldsAll.

HoldsTest::removeUsername3() — Method in class HoldsTest

Retry cleanup method in case of failure during testPlaceHoldWithoutPickUpLocations.

OAuth2Test::restoreOpenSSLKeyPair() — Method in class OAuth2Test

Restore any previous public/private key pair

OAuth2Test::restoreConfigs() — Method in class OAuth2Test

Restore configurations to the state they were in prior to a call to changeConfig().

RecordActionsTestClass in namespace VuFindTest\Mink

Mink record actions test class.

RecordActionsTest::removeUsername2() — Method in class RecordActionsTest

Retry cleanup method in case of failure during testAddTag.

RecordActionsTest::removeUsername2And3And4() — Method in class RecordActionsTest

Retry cleanup method in case of failure during testRating.

RecordActionsTest::removeEmailManiac() — Method in class RecordActionsTest

Retry cleanup method in case of failure during testEmail.

RecordTestClass in namespace VuFindTest\Mink

Mink test class for basic record functionality.

RecordVersionsTestClass in namespace VuFindTest\Mink

Record versions test class.

RecordVersionsTest::runVersionsTest() — Method in class RecordVersionsTest

Run test procedure for record versions.

SavedSearchesTest::removeUsername2() — Method in class SavedSearchesTest

Retry cleanup method in case of failure during testSavedSearchSecurity.

UserIpReaderTest::runFilterTests() — Method in class UserIpReaderTest

Support method for testMultipleHeadersWithFilter().

RefreshTokenRepositoryTestClass in namespace VuFindTest\OAuth2\Repository

OAuth2 RefreshTokenRepository tests.

ExternalSearchTest::runProcedure() — Method in class ExternalSearchTest

Run a test scenario

RandomRecommendTestClass in namespace VuFindTest\Recommend

Random Recommend tests.

$ RandomRecommendTest#recommendProperty in class RandomRecommendTest

Random recommendation module class

RecommendLinksTestClass in namespace VuFindTest\Recommend

RecommendLinks recommendation module Test Class

RecommendLinksTest::runTestProcedure() — Method in class RecommendLinksTest

Run a test scenario

ReviewsTestClass in namespace VuFindTest\RecordTab

Reviews Test Class

$ CacheTest#recordTableProperty in class CacheTest
RouterTestClass in namespace VuFindTest\Record

Record router tests.

RediTestClass in namespace VuFindTest\Resolver\Driver

Redi resolver driver test

RouteGeneratorTestClass in namespace VuFindTest\Route

Route Generator Test Class

ResultsTestClass in namespace VuFindTest\Search\Blender

Blender Results Tests

ResultsTestClass in namespace VuFindTest\Search\Solr

Solr Search Object Results Test

SpellingProcessorTest::runSpellingTest() — Method in class SpellingProcessorTest

Generic test.

ResultsClass in namespace VuFindTest\Search\TestHarness

Test results search model.

RedisTestClass in namespace VuFindTest\Session

Redis Session Handler Test Class

RecommendDeferredTestCaseClass in namespace VuFindTest\Unit

Abstract base class for PHPUnit deferred recommendation module test cases.

GoogleAnalyticsTest::renderGA() — Method in class GoogleAnalyticsTest

Render the GA code

GoogleTagManagerTest::renderGTMHeadCode() — Method in class GoogleTagManagerTest

Render the GTM Head element code

GoogleTagManagerTest::renderGTMBodyCode() — Method in class GoogleTagManagerTest

Render the GTM Body element code

$ OpenUrlTest#rulesConfigProperty in class OpenUrlTest

Configuration array providing basic settings for testing OpenUrlRules

RecordDataFormatterTestClass in namespace VuFindTest\View\Helper\Root

RecordDataFormatter Test Class

RecordLinkerTestClass in namespace VuFindTest\View\Helper\Root

RecordLinker view helper Test Class

RecordTestClass in namespace VuFindTest\View\Helper\Root

Record view helper Test Class

ResourceContainerClass in namespace VuFindTheme

VuFind Theme Public Resource Handler (for CSS, JS, etc.)

ResourceContainer::removeEntry() — Method in class ResourceContainer

Helper function to remove an entry from an array based on filename.

ResourceContainer::removeCSS() — Method in class ResourceContainer

Remove a CSS file if it matches another file's name

ThemeCompiler::removeTheme() — Method in class ThemeCompiler

Remove a theme directory (used for cleanup in testing).

$ AbstractRelaisAction#relaisProperty in class AbstractRelaisAction

Relais connector

$ CommentRecord#recordLoaderProperty in class CommentRecord

Record loader

$ DoiLookup#resolversProperty in class DoiLookup

DOI resolver configuration value, exploded into an array of options

$ GetFacetData#resultsManagerProperty in class GetFacetData

Solr search results manager

$ GetIlsStatus#rendererProperty in class GetIlsStatus

View renderer

$ GetItemStatuses#rendererProperty in class GetItemStatuses

View renderer

GetItemStatuses::reduceServices() — Method in class GetItemStatuses

Reduce an array of service names to a human-readable string.

GetItemStatuses::renderFullStatus() — Method in class GetItemStatuses

Render full item status.

$ GetRecordCommentsAsHTML#rendererProperty in class GetRecordCommentsAsHTML

View renderer

$ GetRecordCover#recordLoaderProperty in class GetRecordCover

Record loader

$ GetRecordCover#rendererProperty in class GetRecordCover

PHP renderer

$ GetRecordDetails#requestProperty in class GetRecordDetails
Request
$ GetRecordDetails#recordLoaderProperty in class GetRecordDetails

Record loader

$ GetRecordDetails#rendererProperty in class GetRecordDetails

View renderer

$ GetRecordRating#recordLoaderProperty in class GetRecordRating

Record loader

$ GetRecordRating#recordHelperProperty in class GetRecordRating

Record helper

$ GetRecordTags#rendererProperty in class GetRecordTags

View renderer

$ GetRecordVersions#recordLoaderProperty in class GetRecordVersions

Record loader

$ GetRecordVersions#recordPluginProperty in class GetRecordVersions

Record plugin

$ GetResolverLinks#rendererProperty in class GetResolverLinks

View renderer

$ GetResultCount#resultsManagerProperty in class GetResultCount
ResultsManager
$ GetSideFacets#recommendPluginManagerProperty in class GetSideFacets

Recommend plugin manager

$ GetSideFacets#rendererProperty in class GetSideFacets

View renderer

$ GetVisData#resultsProperty in class GetVisData

Solr search results object

RecommendClass in namespace VuFind\AjaxHandler

Load a recommendation module via AJAX.

$ Recommend#resultsProperty in class Recommend

Solr search results object

$ Recommend#rendererProperty in class Recommend

View renderer

RecommendFactoryClass in namespace VuFind\AjaxHandler

Factory for Recommend AJAX handler.

RelaisAvailabilityClass in namespace VuFind\AjaxHandler

Relais: Check item availability using a generic patron ID

RelaisInfoClass in namespace VuFind\AjaxHandler

Relais: Check if logged-in patron can order an item.

RelaisOrderClass in namespace VuFind\AjaxHandler

Relais: Order an item.

$ SystemStatus#resultsManagerProperty in class SystemStatus

Results manager

AbstractBase::resetState() — Method in class AbstractBase

Reset any internal status; this is essentially an event hook which most auth modules can ignore. See ChoiceAuth for a use case example.

ChoiceAuth::resetState() — Method in class ChoiceAuth

Reset any internal status; this is essentially an event hook which most auth modules can ignore. See ChoiceAuth for a use case example.

$ EmailAuthenticator#remoteAddressProperty in class EmailAuthenticator

Remote address

$ Shibboleth#requestProperty in class Shibboleth

Http Request object

$ Solr#resultsManagerProperty in class Solr

Results plugin manager

$ SolrPrefix#resultsManagerProperty in class SolrPrefix

Results manager

CacheTrait::removeCachedData() — Method in class CacheTrait

Helper function for removing cached data.

ReCaptchaClass in namespace VuFind\Captcha

ReCaptcha CAPTCHA.

$ ReCaptcha#recaptchaProperty in class ReCaptcha

ReCaptcha Service.

ReCaptchaFactoryClass in namespace VuFind\Captcha

ReCaptcha CAPTCHA factory.

$ Cart#recordLoaderProperty in class Cart

Record loader

Cart::removeItems() — Method in class Cart

Remove an item from the cart.

$ AbstractChannelProvider#recordRouterProperty in class AbstractChannelProvider

Record router

$ AlphaBrowse#recordRouterProperty in class AlphaBrowse

Record router

$ AlphaBrowse#rowsBeforeProperty in class AlphaBrowse

How many rows to show before the selected value

$ ChannelLoader#recordLoaderProperty in class ChannelLoader

Record loader

$ Facets#resultsManagerProperty in class Facets

Search results manager.

$ ListItems#resourceTagsProperty in class ListItems

UserList table

$ ListItems#resultsManagerProperty in class ListItems

Results manager

RandomClass in namespace VuFind\ChannelProvider

"Random items" channel provider.

RandomFactoryClass in namespace VuFind\ChannelProvider

Factory for Random channel provider.

RecentlyReturnedClass in namespace VuFind\ChannelProvider

"Recently returned" channel provider.

RouterInitializerClass in namespace VuFind\ChannelProvider

Channel Provider Router Initializer

$ SimilarItems#recordRouterProperty in class SimilarItems

Record router

PluginManager::reload() — Method in class PluginManager

Reload a configuration and return the new version

$ CacheDecorator#readerProperty in class CacheDecorator

The decorated reader.

$ Upgrade#rawDirProperty in class Upgrade

Directory containing unmodified new configurations

Upgrade::run() — Method in class Upgrade

Run through all of the necessary upgrading.

Upgrade::renameFacet() — Method in class Upgrade

Support method for upgradeFacetsAndCollection() - change the name of a facet field.

Oracle::returnParam() — Method in class Oracle

Same as bindParam(), but variable is parsed by reference to allow for correct functioning of the 'RETURNING' sql statement. Annoying, but putting it in two separate functions allows the user to pass string literals into bindParam without a fatal error.

Oracle::rollback() — Method in class Oracle

Wrapper around oci_rollback.

RelaisClass in namespace VuFind\Connection

Relais connection class.

Relais::request() — Method in class Relais

Make an API request

RelaisFactoryClass in namespace VuFind\Connection

Relais factory.

WorldCatUtils::retrieve() — Method in class WorldCatUtils

Retrieve data over HTTP.

$ Channels#requestProperty in class Channels

Request object

LocalFile::replaceEnvironmentAndIdTokens() — Method in class LocalFile

Convert tokens to ids array values.

LocalFile::replaceImageTypeTokens() — Method in class LocalFile

Convert tokens to image type file extension.

$ ObalkyKnihService#referrerProperty in class ObalkyKnihService

Http referrer

AbstractBase::renewals() — Method in class AbstractBase

Renewals plugin

AbstractBase::reserves() — Method in class AbstractBase

Reserves plugin

AbstractBase::resultScroller() — Method in class AbstractBase

ResultScroller plugin

AbstractRecord::ratingAction() — Method in class AbstractRecord

Display and add ratings

AbstractRecord::rdfAction() — Method in class AbstractRecord

Special action for RDF export

AbstractRecord::redirectToRecord() — Method in class AbstractRecord

Redirect the user to the main record view.

AbstractRecord::resultScrollerActive() — Method in class AbstractRecord

Is the result scroller active?

$ AbstractSearch#rememberSearchProperty in class AbstractSearch

Should we remember the search for breadcrumb purposes?

AbstractSearch::redirectToSavedSearch() — Method in class AbstractSearch

Given a saved search ID, redirect the user to the appropriate place.

AbstractSearch::resultScrollerActive() — Method in class AbstractSearch

Is the result scroller active?

AbstractSearch::rememberSearch() — Method in class AbstractSearch

Store the URL of the provided search (if appropriate).

AbstractSearch::redirectToLegalSearchPage() — Method in class AbstractSearch

If the search backend has thrown a "deep paging" exception, we should show a flash message and redirect the user to a legal page.

AbstractSearch::resultsAction() — Method in class AbstractSearch

Send search results to results view

AbstractSearch::retrieveSearchSecurely() — Method in class AbstractSearch

Get a saved search, enforcing user ownership. Returns row if found, null otherwise.

AbstractSearch::restoreAdvancedSearch() — Method in class AbstractSearch

Either assign the requested search object to the view or display a flash message indicating why the operation failed.

AjaxController::recommendAction() — Method in class AjaxController

Load a recommendation module via AJAX.

AuthorController::resultsAction() — Method in class AuthorController

Sets the configuration for displaying author results

AuthorController::resultScrollerActive() — Method in class AuthorController

Is the result scroller active?

BrowseController::regionAction() — Method in class BrowseController

Browse Region

CartController::redirectToSource() — Method in class CartController

Support method: redirect to the page we were on when the bulk action was initiated.

ChannelsController::recordAction() — Method in class ChannelsController

Generates channels for a record.

CollectionController::resultScrollerActive() — Method in class CollectionController

Is the result scroller active?

CombinedController::resultAction() — Method in class CombinedController

Single result action (used for AJAX)

CombinedController::resultsAction() — Method in class CombinedController

Results action

EITController::resultScrollerActive() — Method in class EITController

Is the result scroller active?

EITrecordController::resultScrollerActive() — Method in class EITrecordController

Is the result scroller active?

EdsController::resultScrollerActive() — Method in class EdsController

Is the result scroller active?

EdsrecordController::redirectToEbook() — Method in class EdsrecordController

Redirect to an eBook.

EdsrecordController::resultScrollerActive() — Method in class EdsrecordController

Is the result scroller active?

RecordVersionsSearchTraitClass in namespace VuFind\Controller\Feature

VuFind Action Feature Trait - Record Versions Search

ResponseFormatterTraitClass in namespace VuFind\Controller\Feature

VuFind Action Feature Trait - HTTP response formatting support methods

LibGuidesController::resultScrollerActive() — Method in class LibGuidesController

Is the result scroller active?

MyResearchController::recoverAction() — Method in class MyResearchController

Send account recovery email

MyResearchController::resetNewPasswordForm() — Method in class MyResearchController

Reset the new password form and return the modified view. When a user has already been loaded from an existing hash, this resets the hash and updates the form so that the user can try again.

$ OAuth2Controller#resourceServerFactoryProperty in class OAuth2Controller

OAuth2 resource server factory

AbstractRequestBase::resetValidation() — Method in class AbstractRequestBase

Reset the array of valid IDs in the session (used for form submission validation)

AbstractRequestBase::rememberValidId() — Method in class AbstractRequestBase

Add an ID to the validation array.

Followup::retrieve() — Method in class Followup

Retrieve the stored followup information.

Followup::retrieveAndClear() — Method in class Followup

Retrieve and then clear a particular followup element.

RenewalsClass in namespace VuFind\Controller\Plugin

Action helper to perform renewal-related actions

ReservesClass in namespace VuFind\Controller\Plugin

Action helper to perform reserves-related actions

ReservesFactoryClass in namespace VuFind\Controller\Plugin

Factory for Reserves controller plugin.

ResultScrollerClass in namespace VuFind\Controller\Plugin

Class for managing "next" and "previous" navigation within result sets.

$ ResultScroller#resultsManagerProperty in class ResultScroller

Results manager

ResultScroller::restoreLastSearch() — Method in class ResultScroller

Restore the last saved search.

ResultScroller::rememberSearch() — Method in class ResultScroller

Update the remembered "last search" in the session.

ResultScrollerFactoryClass in namespace VuFind\Controller\Plugin

Factory for ResultScroller controller plugin.

PrimoController::resultScrollerActive() — Method in class PrimoController

Is the result scroller active?

PrimorecordController::resultScrollerActive() — Method in class PrimorecordController

Is the result scroller active?

RecordControllerClass in namespace VuFind\Controller

Record Controller

RecordController::resultScrollerActive() — Method in class RecordController

Is the result scroller active?

RecordsControllerClass in namespace VuFind\Controller

Records Controller

RelaisControllerClass in namespace VuFind\Controller

Relais Controller

RelaisController::requestAction() — Method in class RelaisController

Relais request action.

Search2Controller::resultScrollerActive() — Method in class Search2Controller

Is the result scroller active?

Search2recordController::resultScrollerActive() — Method in class Search2recordController

Is the result scroller active?

SearchController::reservesAction() — Method in class SearchController

Course reserves

SearchController::reservesfacetlistAction() — Method in class SearchController

Show facet list for Solr-driven reserves.

SearchController::reservessearchAction() — Method in class SearchController

Show search form for Solr-driven reserves.

SearchController::reservesresultsAction() — Method in class SearchController

Show results of reserves search.

SearchController::resultsAction() — Method in class SearchController

Results action.

SearchController::resultScrollerActive() — Method in class SearchController

Is the result scroller active?

$ ShortlinkController#redirectDelayHtmlProperty in class ShortlinkController

Amount of seconds after which HTML redirect is performed.

$ ShortlinkController#redirectMethodProperty in class ShortlinkController

Which redirect mechanism to use (html, http, threshold:)

ShortlinkController::redirectViaHtml() — Method in class ShortlinkController

Redirect to given URL by using a HTML meta redirect mechanism.

ShortlinkController::redirectViaHttp() — Method in class ShortlinkController

Redirect to given URL by using a HTTP header.

ShortlinkController::redirectAction() — Method in class ShortlinkController

Resolve full version of shortlink & redirect to target.

SummonController::resultScrollerActive() — Method in class SummonController

Is the result scroller active?

SummonrecordController::resultScrollerActive() — Method in class SummonrecordController

Is the result scroller active?

UpgradeController::resetAction() — Method in class UpgradeController

Start over with the upgrade process in case of an error.

WorldcatController::resultScrollerActive() — Method in class WorldcatController

Is the result scroller active?

WorldcatrecordController::resultScrollerActive() — Method in class WorldcatrecordController

Is the result scroller active?

Generator::renderPng() — Method in class Generator

Render the contents of the image in the object to a PNG; return as string.

DefaultText::render() — Method in class DefaultText

Render the layer

GridBackground::render() — Method in class GridBackground

Render the layer

GridBackground::renderGrid() — Method in class GridBackground

Convert 16 long binary string to 8x8 color grid Reflects vertically and horizontally

InitialText::render() — Method in class InitialText

Render the layer

LayerInterface::render() — Method in class LayerInterface

Render the layer

SolidBackground::render() — Method in class SolidBackground

Render the layer

$ Loader#recordidProperty in class Loader

User record id number parameter

RouterClass in namespace VuFind\Cover

Cover image router

RouterFactoryClass in namespace VuFind\Cover

Cover router factory.

OaiResumption::restoreParams() — Method in class OaiResumption

Extract an array of parameters from the object.

RatingsClass in namespace VuFind\Db\Row

Row Definition for ratings

RecordClass in namespace VuFind\Db\Row

Row Definition for user

ResourceClass in namespace VuFind\Db\Row

Row Definition for resource

$ Resource#record_idProperty in class Resource
ResourceTagsClass in namespace VuFind\Db\Row

Row Definition for resource_tags

RowGatewayClass in namespace VuFind\Db\Row

Abstract base class for DB rows.

RowGatewayFactoryClass in namespace VuFind\Db\Row

Generic row gateway factory.

User::removeResourcesById() — Method in class User

Given an array of item ids, remove them from all lists

UserList::rememberLastUsed() — Method in class UserList

Remember that this list was used so that it can become the default in dialog boxes.

UserList::removeResourcesById() — Method in class UserList

Given an array of item ids, remove them from all lists

ChangeTracker::retrieve() — Method in class ChangeTracker

Retrieve a row from the database based on primary key; return null if it is not found.

ChangeTracker::retrieveDeletedCount() — Method in class ChangeTracker

Retrieve a set of deleted rows from the database.

ChangeTracker::retrieveDeleted() — Method in class ChangeTracker

Retrieve a set of deleted rows from the database.

ChangeTracker::retrieveOrCreate() — Method in class ChangeTracker

Retrieve a row from the database based on primary key; create a new row if no existing match is found.

OaiResumption::removeExpired() — Method in class OaiResumption

Remove all expired tokens from the database.

RatingsClass in namespace VuFind\Db\Table

Table Definition for ratings

RecordClass in namespace VuFind\Db\Table

Table Definition for record

ResourceClass in namespace VuFind\Db\Table

Table Definition for resource

$ Resource#recordLoaderProperty in class Resource

Record loader

ResourceFactoryClass in namespace VuFind\Db\Table

Resource table gateway factory.

ResourceTagsClass in namespace VuFind\Db\Table

Table Definition for resource_tags

Session::readSession() — Method in class Session

Retrieve data for the given session ID.

Tags::resourceSearch() — Method in class Tags

Get all resources associated with the provided tag query.

$ OverdriveConnector#recordConfigProperty in class OverdriveConnector

Record Config

OverdriveConnector::returnResource() — Method in class OverdriveConnector

Return Resource Return a title early.

OverdriveConnector::removeCachedData() — Method in class OverdriveConnector

Helper function for removing cached data.

$ HttpDownloadException#responseHeadersProperty in class HttpDownloadException

HTTP response headers associated with this exception.

$ HttpDownloadException#responseBodyProperty in class HttpDownloadException

HTTP response body associated with this exception.

RecordMissingClass in namespace VuFind\Exception

Record Missing Exception

Export::recordSupportsFormat() — Method in class Export

Does the specified record support the specified export format?

$ FavoritesService#recordCacheProperty in class FavoritesService

Record cache

$ FavoritesService#resourceTableProperty in class FavoritesService

Resource database table

Entry::render() — Method in class Entry

Render entry

Feed::render() — Method in class Feed

Render feed

Form::reportReferrer() — Method in class Form

Check if the form should report referrer url

Form::reportUserAgent() — Method in class Form

Check if the form should report browser's user agent

$ BasemapConfig#requestOriginProperty in class BasemapConfig

Request origin

$ AbstractBase#rendererManagerProperty in class AbstractBase

Tree renderer plugin manager

AbstractBase::render() — Method in class AbstractBase

Render the tree for a given record.

$ AbstractBase#recordRouteProperty in class AbstractBase

Record page route.

$ Search2#recordRouteProperty in class Search2

Record page route.

$ AbstractBase#recordDriverProperty in class AbstractBase

Hierarchical record to work on

AbstractBase::render() — Method in class AbstractBase

Render the Hierarchy Tree

$ JSTree#routerProperty in class JSTree

Router plugin

JSTree::render() — Method in class JSTree

Render the Hierarchy Tree

RemoteAddressFactoryClass in namespace VuFind\Http\PhpEnvironment

RemoteAddress utility factory.

RequestClass in namespace VuFind\Http\PhpEnvironment

HTTP Request class

$ LocaleSettings#rightToLeftLocalesProperty in class LocaleSettings

Array of locales that use right-to-left formatting.

$ Sorter#respectLocaleProperty in class Sorter

Do respect current locale?

$ ExtendedIni#readerProperty in class ExtendedIni

Helper for reading .ini files from disk.

ExtendedIni::resetLoadedFiles() — Method in class ExtendedIni

Reset the loaded file list.

$ Connection#requestProperty in class Connection

Request object

Aleph::renewMyItems() — Method in class Aleph

Renew My Items

AlephTranslator::regexp() — Method in class AlephTranslator

Apply standard regular expression cleanup to a string.

Alma::renewMyItems() — Method in class Alma

Renew loans via Alma API.

$ Demo#requestProperty in class Demo

HTTP Request object (if available).

Demo::renewMyItems() — Method in class Demo

Renew My Items

Folio::renewTenantToken() — Method in class Folio

Login and receive a new token

Folio::renewMyItems() — Method in class Folio

Attempt to renew a list of items for a given patron.

GeniePlus::renewAccessToken() — Method in class GeniePlus

Renew the OAuth access token needed by the API.

HorizonXMLAPI::registerUser() — Method in class HorizonXMLAPI

Register User

HorizonXMLAPI::renewItems() — Method in class HorizonXMLAPI

Renew Items

HorizonXMLAPI::renewMyItems() — Method in class HorizonXMLAPI

Renew My Items

KohaILSDI::renewMyItems() — Method in class KohaILSDI

Renew My Items

$ KohaRest#renewalBlockMappingsProperty in class KohaRest

Mappings from renewal block reasons

KohaRest::renewMyItems() — Method in class KohaRest

Renew My Items

$ NoILS#recordLoaderProperty in class NoILS

Record loader

PAIA::renewMyItems() — Method in class PAIA

This method renews a list of items for a specific patron.

Polaris::renewMyItems() — Method in class Polaris

Renew My Items

Polaris::reactivateHolds() — Method in class Polaris

Reactivate Holds

SierraRest::renewMyItems() — Method in class SierraRest

Renew My Items

SierraRest::renewAccessToken() — Method in class SierraRest

Renew the API access token and store it in the cache.

$ Symphony#recordLoaderProperty in class Symphony

Record loader

Symphony::renewMyItems() — Method in class Symphony

Renew My Items

Unicorn::renewMyItems() — Method in class Unicorn

Renew My Items

Virtua::renderPartSubPattern() — Method in class Virtua

Patterns coming in here are either all chrono patterns, or no chrono patterns.

Virtua::renderSubPattern() — Method in class Virtua

Breaks up the full pattern into chrono and other chrono = (year) etc... ie. gets replaced inline other = most enum holdings or 'Pt.'... ie. get concatenated

Virtua::renderOtherPattern() — Method in class Virtua

Currently used to handled note SUBfields eg. 863/z, not 866 generally but anything non enum and chrono related ends up here.

Virtua::renderPattern() — Method in class Virtua

Renders individual holdings against a pattern Note fields and prediction patterns are handled separately

Virtua::renderSerialHoldings() — Method in class Virtua

A function turning holdings marc into an array of display ready strings.

Virtua::renewMyItems() — Method in class Virtua

Renew My Items

$ VoyagerRestful#recallsEnabledProperty in class VoyagerRestful

Whether recalls are enabled

$ VoyagerRestful#requestGroupsEnabledProperty in class VoyagerRestful

Whether request groups are enabled

VoyagerRestful::requestGroupSortFunction() — Method in class VoyagerRestful

Sort function for sorting request groups

VoyagerRestful::renewMyItems() — Method in class VoyagerRestful

Renew My Items

$ XCNCIP2#requestAvailableStatusProperty in class XCNCIP2

Lowercased status string for requests available for pickup by patron

$ XCNCIP2#responsesProperty in class XCNCIP2

L1 cache for NCIP responses to save some http connections. Responses are save as in following structure: [ 'ServiceName' => [ 'someId' => \SimpleXMLElement ] ]

XCNCIP2::renewMyItems() — Method in class XCNCIP2

Renew My Items

XCNCIP2::registerNamespaceFor() — Method in class XCNCIP2

Register namespace(s) for an XML element/tree

Mailer::resetConnection() — Method in class Mailer

Reset the connection in the transport. Implements a fluent interface.

$ Server#repositoryNameProperty in class Server

Repository name used in "Identify" response

$ Server#resultsManagerProperty in class Server

Results plugin manager

$ Server#recordLoaderProperty in class Server

Record loader

$ Server#recordLinkerHelperProperty in class Server

Record link helper (optional)

$ Server#recordFormatterProperty in class Server
$ Server#recordFormatFiltersProperty in class Server

Filter queries specific to the requested record format

RefreshTokenEntityClass in namespace VuFind\OAuth2\Entity

OAuth2 refresh token entity implementation.

AbstractTokenRepository::revoke() — Method in class AbstractTokenRepository

Revoke a token

AccessTokenRepository::revokeAccessToken() — Method in class AccessTokenRepository

Revoke an access token.

AuthCodeRepository::revokeAuthCode() — Method in class AuthCodeRepository

Revoke an authentication code.

RefreshTokenRepositoryClass in namespace VuFind\OAuth2\Repository

OAuth2 refresh token repository implementation.

RefreshTokenRepository::revokeRefreshToken() — Method in class RefreshTokenRepository

Revoke a refresh token.

RepositoryWithAccessTokenTableFactoryClass in namespace VuFind\OAuth2\Repository

Factory for repositories requiring the access token table.

RepositoryWithOAuth2ConfigFactoryClass in namespace VuFind\OAuth2\Repository

Factory for repositories requiring OAuth2 configuration.

$ AbstractFacets#resultsProperty in class AbstractFacets

Search results

$ AbstractResultsPassthrough#resultsProperty in class AbstractResultsPassthrough

Search results object.

$ AbstractSummonRecommend#resultsProperty in class AbstractSummonRecommend

Database details

$ AbstractSummonRecommend#requestParamProperty in class AbstractSummonRecommend

Request parameter to pull query from

$ AbstractSummonRecommend#resultsManagerProperty in class AbstractSummonRecommend

Results plugin manager

$ AbstractSummonRecommendDeferred#rawParamsProperty in class AbstractSummonRecommendDeferred

Raw configuration parameters

$ AuthorFacets#resultsProperty in class AuthorFacets

Search results object

$ AuthorFacets#resultsManagerProperty in class AuthorFacets

Results plugin manager

$ AuthorInfo#resultsManagerProperty in class AuthorInfo

Results plugin manager

$ AuthorityRecommend#resultLimitProperty in class AuthorityRecommend

Maximum number of results that will be accompanied by recommendations (set to 0 for no limit).

$ AuthorityRecommend#resultsProperty in class AuthorityRecommend

Current user search

$ AuthorityRecommend#recommendationsProperty in class AuthorityRecommend

Generated recommendations

$ AuthorityRecommend#resultsManagerProperty in class AuthorityRecommend

Results plugin manager

$ DOI#redirectFullMatchProperty in class DOI

Are we configured to redirect to the resolver when a full match is found?

DOI::redirectFullMatch() — Method in class DOI

Are we configured to redirect to the resolver when a full match is found?

$ DPLATerms#returnFieldsProperty in class DPLATerms

List of fields to retrieve from the API

$ EDSResultsDeferred#rawParamsProperty in class EDSResultsDeferred

Raw configuration parameters

$ EuropeanaResults#requestParamProperty in class EuropeanaResults

Request parameter for searching

$ EuropeanaResults#resultsProperty in class EuropeanaResults

Search results

$ EuropeanaResultsDeferred#rawParamsProperty in class EuropeanaResultsDeferred

Raw configuration parameters

$ OpenLibrarySubjects#requestParamProperty in class OpenLibrarySubjects

Parameter to use for search terms

$ OpenLibrarySubjects#resultProperty in class OpenLibrarySubjects

Result of search (false if none)

$ OpenLibrarySubjectsDeferred#rawParamsProperty in class OpenLibrarySubjectsDeferred

Raw configuration string

RandomRecommendClass in namespace VuFind\Recommend

RandomRecommend Module

$ RandomRecommend#resultsProperty in class RandomRecommend
Results
RandomRecommendFactoryClass in namespace VuFind\Recommend

RandomRecommend recommendation module factory.

RecommendInterfaceClass in namespace VuFind\Recommend

Search Recommendations Interface

RecommendLinksClass in namespace VuFind\Recommend

RecommendLinks Recommendations Module

RemoveFiltersClass in namespace VuFind\Recommend

RemoveFilters Recommendations Module Recommends to remove filters

$ RemoveFilters#resultsProperty in class RemoveFilters

Search results object.

$ SearchObject#resultsProperty in class SearchObject

Results object

$ SearchObject#requestParamProperty in class SearchObject

Name of request parameter to use for search query

$ SearchObject#runnerProperty in class SearchObject

Search runner

$ SwitchQuery#resultsProperty in class SwitchQuery

Search results object.

$ SwitchType#resultsProperty in class SwitchType

Results object

$ AbstractBase#recordConfigProperty in class AbstractBase

Record-specific configuration

$ AbstractBase#ratingCacheProperty in class AbstractBase

Cache for rating data

EDS::replaceBRWithCommas() — Method in class EDS

Replace
tags that are embedded in data to commas

EDS::recurseIntoRecordInfo() — Method in class EDS

Recursive support method for extractEbscoDataFromRecordInfo().

$ AbstractBase#requestProperty in class AbstractBase

User request associated with the tab (false for none)

$ AbstractContent#resultsProperty in class AbstractContent

Cache for results.

CollectionHierarchyTree::renderTree() — Method in class CollectionHierarchyTree

Render a hierarchy tree

$ CollectionList#resultsProperty in class CollectionList

Search results object (null prior to processing)

$ CollectionList#runnerProperty in class CollectionList

Search runner

$ CollectionList#recommendManagerProperty in class CollectionList

Recommendation manager

$ ComponentParts#resultsProperty in class ComponentParts

Similar records

HierarchyTree::renderTree() — Method in class HierarchyTree

Render a hierarchy tree

ReviewsClass in namespace VuFind\RecordTab

Reviews tab

ReviewsFactoryClass in namespace VuFind\RecordTab

Factory for building Reviews tab.

$ SimilarItemsCarousel#resultsProperty in class SimilarItemsCarousel

Similar records

$ Cache#recordTableProperty in class Cache

Database table used by cache

$ Cache#recordFactoryManagerProperty in class Cache

Record driver plugin manager

RecordCacheAwareInterfaceClass in namespace VuFind\Record\Cache
RecordCacheAwareInterface
RecordCacheAwareTraitClass in namespace VuFind\Record\Cache

Default implementation of RecordCacheAwareInterface

$ RecordCacheAwareTrait#recordCacheProperty in class RecordCacheAwareTrait

Record cache

$ Loader#recordFactoryProperty in class Loader

Record factory

$ Loader#recordCacheProperty in class Loader

Record cache

RouterClass in namespace VuFind\Record

Record route generator

RelatedInterfaceClass in namespace VuFind\Related

Related Records Interface

$ Similar#resultsProperty in class Similar

Similar records

$ CsvReader#reservesProperty in class CsvReader

Reserves data loaded from files

RediClass in namespace VuFind\Resolver\Driver

ReDi Link Resolver Driver

Redi::removeDoubleAngleQuotationMarks() — Method in class Redi

Helper function to remove hardcoded link-string "»" in Redi response

$ DynamicRoleProvider#rolesProperty in class DynamicRoleProvider

Cache of role objects.

$ IpRange#requestProperty in class IpRange

Request object

$ IpRegEx#requestProperty in class IpRegEx

Request object

RoleClass in namespace VuFind\Role\PermissionProvider

Role permission provider for VuFind.

$ ServerParam#requestProperty in class ServerParam

Request object

$ Shibboleth#requestProperty in class Shibboleth

Request object

RouteGeneratorClass in namespace VuFind\Route

Route Generator Class

$ RouteGenerator#recordRoutesProperty in class RouteGenerator

Cache for already added recordActions which need to be used again if additional nonTabRecordActions will be added later.

$ BackendManager#registryProperty in class BackendManager

Backend registry.

$ FacetCache#resultsProperty in class FacetCache

Search results object.

$ Options#rssSortProperty in class Options

RSS-specific sort option

$ Options#retainFiltersByDefaultProperty in class Options

Should we retain filters by default?

$ Options#resultLimitProperty in class Options

Maximum number of results (no limit by default)

Params::removeFilter() — Method in class Params

Remove a filter from the list.

Params::removeAllFilters() — Method in class Params

Remove all filters from the list.

Params::resetFacetConfig() — Method in class Params

Reset the current facet configuration.

ResultsClass in namespace VuFind\Search\Base

Abstract results search model.

$ Results#resultTotalProperty in class Results

Total number of results available

$ Results#resultsProperty in class Results

Array of results (represented as Record Driver objects) retrieved on latest search

$ Results#recommendProperty in class Results
Recommendations
$ Results#recordLoaderProperty in class Results

Record loader

$ Options#resultLimitProperty in class Options

Maximum number of results (400 by default)

Params::removeFilter() — Method in class Params

Remove a filter from the list.

Params::removeAllFilters() — Method in class Params

Remove all filters from the list.

Params::resetFacetConfig() — Method in class Params

Reset the current facet configuration.

ResultsClass in namespace VuFind\Search\Blender

Blender aspect of the Search Multi-class (Results)

ResultsClass in namespace VuFind\Search\BrowZine

BrowZine Search Results

ResultsClass in namespace VuFind\Search\Combined

Combined results search model.

ResultsClass in namespace VuFind\Search\EDS

EDS API Results

$ Results#responseFacetsProperty in class Results

Facet list

ResultsClass in namespace VuFind\Search\EIT

EBSCO Search Parameters Partially copied from WorldCat Search Parameters; partially copied from other pieces of VuFind code

ResultsClass in namespace VuFind\Search\EmptySet

Simple search results object to represent an empty set (used when dealing with exceptions that prevent a "real" search object from being constructed).

$ AbstractSolrBackendFactory#recordCollectionClassProperty in class AbstractSolrBackendFactory

Record collection class for RecordCollectionFactory

$ AbstractSolrBackendFactory#recordCollectionFactoryClassProperty in class AbstractSolrBackendFactory

Record collection factory class

ResultsClass in namespace VuFind\Search\Favorites

Search Favorites Results

$ Results#resourceTableProperty in class Results

Resource table

ResultsFactoryClass in namespace VuFind\Search\Favorites

Factory for Favorites search results objects.

$ History#resultsManagerProperty in class History

Results manager

ResultsClass in namespace VuFind\Search\LibGuides

LibGuides Search Parameters

Memory::rememberLastSettings() — Method in class Memory

Remember a user's last search parameters.

Memory::rememberParams() — Method in class Memory

Wrapper around rememberLastSettings() to extract key values from a search Params object.

Memory::rememberSearch() — Method in class Memory

Store the last accessed search URL in the session for future reference.

Memory::retrieveLastSetting() — Method in class Memory

Retrieve a previous user parameter, if available. Return $default if not found.

Memory::retrieveSearch() — Method in class Memory

Retrieve last accessed search URL, if available. Returns null if no URL is available.

$ Minified#rProperty in class Minified

Total result count

$ Params#recordsToRequestProperty in class Params

Array of target record ids

ResultsClass in namespace VuFind\Search\MixedList

Search Mixed List Results

$ NormalizedSearch#resultsManagerProperty in class NormalizedSearch

Search results manager

$ NormalizedSearch#rawProperty in class NormalizedSearch

Raw search object provided to constructor

ResultsClass in namespace VuFind\Search\Pazpar2

Pazpar2 Search Parameters

ResultsClass in namespace VuFind\Search\Primo

Primo Central Search Parameters

$ Results#responseFacetsProperty in class Results

Facet details:

RecommendListenerClass in namespace VuFind\Search

Recommend listener.

ResultsFactoryClass in namespace VuFind\Search\Results

Generic factory for search results objects.

ResultsClass in namespace VuFind\Search\Search2Collection

Search2 Collection Search Options

ResultsClass in namespace VuFind\Search\Search2

Search Results for second Solr index

ResultsFactoryClass in namespace VuFind\Search\Search2

Factory for Search2 results objects.

$ SearchNormalizer#resultsManagerProperty in class SearchNormalizer

Search results manager

$ SearchRunner#resultsManagerProperty in class SearchRunner

Search results object manager.

SearchRunner::run() — Method in class SearchRunner

Run the search.

$ SearchTabsHelper#resultsProperty in class SearchTabsHelper

Search manager

$ SearchTabsHelper#requestProperty in class SearchTabsHelper
Request
ResultsClass in namespace VuFind\Search\SolrAuth

Solr Authority Search Parameters

ResultsClass in namespace VuFind\Search\SolrAuthorFacets

AuthorFacets Search Results

ResultsClass in namespace VuFind\Search\SolrAuthor

Author Search Options

ResultsClass in namespace VuFind\Search\SolrCollection

Solr Collection Search Options

ResultsClass in namespace VuFind\Search\SolrReserves

Solr Reserves Search Parameters

ResultsClass in namespace VuFind\Search\SolrWeb

Solr Web Search Parameters

ResultsClass in namespace VuFind\Search\Solr

Solr Search Parameters

$ Results#responseFacetsProperty in class Results

Field facets.

$ Results#responseQueryFacetsProperty in class Results

Query facets.

$ Results#responsePivotFacetsProperty in class Results

Pivot facets.

ResultsFactoryClass in namespace VuFind\Search\Solr

Factory for Solr search results objects.

Params::resetFacetConfig() — Method in class Params

Reset the current facet configuration.

ResultsClass in namespace VuFind\Search\Summon

Summon Search Parameters

$ Results#responseFacetsProperty in class Results

Facet details:

ResultsClass in namespace VuFind\Search\Tags

Search Tags Results

ResultsFactoryClass in namespace VuFind\Search\Tags

Factory for Tags search results objects.

UrlQueryHelper::regenerateSearchQueryParams() — Method in class UrlQueryHelper

Adjust the internal query array based on the query object.

UrlQueryHelper::replaceTerm() — Method in class UrlQueryHelper

Replace a term in the search query (used for spelling replacement)

UrlQueryHelper::removeAllFilters() — Method in class UrlQueryHelper

Remove all filters.

UrlQueryHelper::resetDefaultFilters() — Method in class UrlQueryHelper

Reset default filter state.

UrlQueryHelper::removeFacet() — Method in class UrlQueryHelper

Remove a facet from the parameters.

UrlQueryHelper::removeFilter() — Method in class UrlQueryHelper

Remove a filter from the parameters.

ResultsClass in namespace VuFind\Search\WorldCat

WorldCat Search Parameters

ReCaptchaClass in namespace VuFind\Service

Recaptcha service

ReCaptchaFactoryClass in namespace VuFind\Service

ReCaptcha factory.

Database::read() — Method in class Database

Read function must return string value always to make save handler work as expected. Return empty string if there is no data to read.

File::read() — Method in class File

Read function must return string value always to make save handler work as expected. Return empty string if there is no data to read.

ManagerFactory::registerShutdownFunction() — Method in class ManagerFactory

According to the PHP manual, session_write_close should always be registered as a shutdown function when using an object as a session handler: http://us.php.net/manual/en/function.session-set-save-handler.php

Memcache::read() — Method in class Memcache

Read function must return string value always to make save handler work as expected. Return empty string if there is no data to read.

RedisClass in namespace VuFind\Session

Redis session handler

$ Redis#redisVersionProperty in class Redis

Redis version

Redis::read() — Method in class Redis

Read function must return string value always to make save handler work as expected. Return empty string if there is no data to read.

RedisFactoryClass in namespace VuFind\Session

Generic factory for instantiating session handlers

SecureDelegator::read() — Method in class SecureDelegator

Read a sessions data.

$ ContentPages#routerProperty in class ContentPages
Router
Database::resolve() — Method in class Database

Resolve URL from Database via id.

None::resolve() — Method in class None

Dummy implementation. Resolving is not necessary because initial URL has not been shortened.

UrlShortenerInterface::resolve() — Method in class UrlShortenerInterface

Resolve a shortened URL by its id.

AbstractSearch::renderExpandLink() — Method in class AbstractSearch

Render an expand link.

AbstractSearch::renderSpellingSuggestions() — Method in class AbstractSearch

Support function to display spelling suggestions.

Search::renderExpandLink() — Method in class Search

Render an expand link.

Auth::renderTemplate() — Method in class Auth

Render a template within an auth module folder.

Citation::reverseName() — Method in class Citation

Turn a "Last, First" name into a "First Last" name.

ClassBasedTemplateRendererTrait::resolveClassTemplate() — Method in class ClassBasedTemplateRendererTrait

Recursively locate a template that matches the provided class name (or one of its parent classes); throw an exception if no match is found.

ClassBasedTemplateRendererTrait::renderClassTemplate() — Method in class ClassBasedTemplateRendererTrait

Render a template associated with the provided class name, applying to specified context variables.

Content::renderTranslated() — Method in class Content

Search for a translated template and render it using a temporary context.

Context::restore() — Method in class Context

Restore an old context returned by apply().

Context::renderInContext() — Method in class Context

Render a template using a temporary context; restore the view to its original state when done. This offers the template full access to the global scope, modified by $context, then puts the global scope back the way it was.

CookieConsent::render() — Method in class CookieConsent

Render cookie consent initialization script

$ Csp#responseProperty in class Csp

Response object

$ Doi#recordDriverProperty in class Doi

Current RecordDriver

Doi::renderTemplate() — Method in class Doi

Public method to render the OpenURL template

GeoCoords::recommendationEnabled() — Method in class GeoCoords

Check if the relevant recommendation module is enabled; if not, there is no point in generating a search link. Note that right now we are assuming it is set up as a default top recommendation; this may need to be made more flexible in future to account for more use cases.

HelpText::render() — Method in class HelpText

Render a help template (or return false if none found).

$ Icon#rtlProperty in class Icon

Are we in right to left text mode?

$ Matomo#requestProperty in class Matomo

Request object

$ Matomo#routerProperty in class Matomo

Router object

$ OpenUrl#resolverPluginManagerProperty in class OpenUrl

Resolver plugin manager

$ OpenUrl#recordDriverProperty in class OpenUrl

Current RecordDriver

OpenUrl::renderTemplate() — Method in class OpenUrl

Public method to render the OpenURL template

$ Piwik#requestProperty in class Piwik

Request object

$ Piwik#routerProperty in class Piwik

Router object

RecommendClass in namespace VuFind\View\Helper\Root

Recommendation module view helper

RecordClass in namespace VuFind\View\Helper\Root

Record driver view helper

Record::renderTemplate() — Method in class Record

Render a template within a record driver folder.

RecordDataFormatterClass in namespace VuFind\View\Helper\Root

Record driver data formatting view helper

RecordDataFormatter::render() — Method in class RecordDataFormatter

Return rendered text (or null if nothing to render).

RecordDataFormatter::renderMulti() — Method in class RecordDataFormatter

Render multiple lines for a single set of data.

RecordDataFormatter::renderRecordHelper() — Method in class RecordDataFormatter

Render using the record view helper.

RecordDataFormatter::renderRecordDriverTemplate() — Method in class RecordDataFormatter

Render a record driver template.

RecordDataFormatter::renderSimple() — Method in class RecordDataFormatter

Simple rendering method.

RecordDataFormatterFactoryClass in namespace VuFind\View\Helper\Root

Factory for record driver data formatting view helper

SpecBuilder::reorderKeys() — Method in class SpecBuilder

Reorder the specs to match the provided array of keys.

RecordFactoryClass in namespace VuFind\View\Helper\Root

Record helper factory.

RecordLinkerClass in namespace VuFind\View\Helper\Root

Record linker view helper

$ RecordLinker#routerProperty in class RecordLinker

Record router

RecordLinker::related() — Method in class RecordLinker

Given an array representing a related record (which may be a bib ID or OCLC number), this helper renders a URL linking to that record.

RecordLinkerFactoryClass in namespace VuFind\View\Helper\Root

RecordLinker helper factory.

RelaisClass in namespace VuFind\View\Helper\Root

Relais view helper

Relais::renderButtonIfActive() — Method in class Relais

Render a button if Relais is active.

RelaisFactoryClass in namespace VuFind\View\Helper\Root

Relais helper factory.

RelatedClass in namespace VuFind\View\Helper\Root

Related records view helper

Related::render() — Method in class Related

Render the output of a related records module.

RelatedFactoryClass in namespace VuFind\View\Helper\Root

Related helper factory.

RenderArrayClass in namespace VuFind\View\Helper\Root

View helper to render a portion of an array.

ResultFeedClass in namespace VuFind\View\Helper\Root

"Results as feed" view helper

ResultFeed::registerExtensions() — Method in class ResultFeed

Set up custom extensions (should be called by factory).

ResultFeedFactoryClass in namespace VuFind\View\Helper\Root

ResultFeed helper factory.

$ SearchTabs#resultsProperty in class SearchTabs

Search manager

$ SearchTabs#requestProperty in class SearchTabs
Request
SearchTabs::remapBasicSearch() — Method in class SearchTabs

Map a search query from one class to another.

$ Url#requestProperty in class Url

Request (or null if unavailable)

VuFind::removeTagAndReturnXMLasText() — Method in class VuFind

Remove a given tag from the provided nodes, then convert into XML and return as text. This is useful for populating the fullrecord field with the raw input XML but allow for removal of certain elements (eg: full text field).

S

Search2ApiControllerClass in namespace KnihovnyCzApi\Controller

Class Search2ApiController

$ Search2ApiController#searchRouteProperty in class Search2ApiController

Search route uri

SearchApiControllerClass in namespace KnihovnyCzApi\Controller

Class SearchApiController

SearchApiControllerFactoryClass in namespace KnihovnyCzApi\Controller

Class SearchApiControllerFactory

Cronjob::siteMapAction() — Method in class Cronjob

Site map endpoint

$ XCNCIP2Test#statusesTestsProperty in class XCNCIP2Test
$ XCNCIP2Test#storageRetrievalTestsProperty in class XCNCIP2Test
$ Edd#searchServiceProperty in class Edd

Search results plugin manager

$ GetACSuggestions#suggesterProperty in class GetACSuggestions

Autocomplete suggester

SaveInstitutionFilterClass in namespace KnihovnyCz\AjaxHandler

"Get Autocomplete Suggestions" AJAX handler

SaveInstitutionFilterFactoryClass in namespace KnihovnyCz\AjaxHandler

Class HarvestWidgetsContentsFactory

SfxClass in namespace KnihovnyCz\AjaxHandler

"Get Autocomplete Suggestions" AJAX handler

SfxFactoryClass in namespace KnihovnyCz\AjaxHandler

SFX AJAX handler

ShibbolethClass in namespace KnihovnyCz\Auth

Shibboleth authentication module.

Shibboleth::setConfig() — Method in class Shibboleth

Set configuration.

SolrAuthorityEnricherClass in namespace KnihovnyCz\Autocomplete
SolrAuthorityEnricher
$ SolrAuthorityEnricher#searchServiceProperty in class SolrAuthorityEnricher

Search service

$ SolrAuthorityEnricher#searchFieldProperty in class SolrAuthorityEnricher

Search field

SolrAuthorityEnricherFactoryClass in namespace KnihovnyCz\Autocomplete

Factory for SolrAuthorityEnricher

SolrFactoryWithFilterClass in namespace KnihovnyCz\Autocomplete

Factory for SolrPrefix and SolrPrefixSorted.

SolrPrefixClass in namespace KnihovnyCz\Autocomplete

Solr autocomplete module with prefix queries using edge N-gram filter

$ SolrPrefix#suggestionFilterProperty in class SolrPrefix

Filter for suggested terms

SolrPrefix::setConfig() — Method in class SolrPrefix

Set configuration

SolrPrefixHandlerClass in namespace KnihovnyCz\Autocomplete

Solr autocomplete module with prefix queries using edge N-gram filter

$ SolrPrefixHandler#searchObjectProperty in class SolrPrefixHandler

Search object

$ SolrPrefixHandler#searchClassIdProperty in class SolrPrefixHandler

Search class id

$ SolrPrefixHandler#searchHandlerProperty in class SolrPrefixHandler

Search handler to use

$ SolrPrefixHandler#suggestionFilterProperty in class SolrPrefixHandler

Filter for suggested terms

SolrPrefixHandler::setConfig() — Method in class SolrPrefixHandler

Set configuration

SolrPrefixSortedClass in namespace KnihovnyCz\Autocomplete

Solr autocomplete module with prefix queries using edge N-gram filter, results are then sorted by supplied function.

$ SolrPrefixSorted#suggestionFilterProperty in class SolrPrefixSorted

Suggestion filter

$ SolrPrefixSorted#searchObjectProperty in class SolrPrefixSorted

Search object

$ SolrPrefixSorted#searchClassIdProperty in class SolrPrefixSorted

Search class id

$ SolrPrefixSorted#sortProperty in class SolrPrefixSorted

Sort function

SolrPrefixSorted::setConfig() — Method in class SolrPrefixSorted

Set parameters that affect the behavior of the autocomplete handler.

SuggesterClass in namespace KnihovnyCz\Autocomplete

Autocomplete handler plugin manager

SuggestionFilterClass in namespace KnihovnyCz\Autocomplete

Class SuggestionFilter

SuggestionFilterFactoryClass in namespace KnihovnyCz\Autocomplete

Factory for SuggestionFilter

$ AbstractDbAwaredRecordIds#searchClassIdProperty in class AbstractDbAwaredRecordIds

Search class ID to use for retrieving facets.

$ AbstractDbAwaredRecordIds#searchTypeProperty in class AbstractDbAwaredRecordIds

Search type

AbstractDbAwaredRecordIds::setSelect() — Method in class AbstractDbAwaredRecordIds

Modify select for getting list items

$ DocumentTypes#searchClassIdProperty in class DocumentTypes

Search class ID to use for retrieving facets.

DocumentTypes::setConfig() — Method in class DocumentTypes

Store the configuration of the content block.

UserList::setSelect() — Method in class UserList

Modify select for getting list items

UserList::setConfig() — Method in class UserList

Store the configuration of the content block.

$ ObalkyKnih#serviceProperty in class ObalkyKnih

Obalky knih service

InspirationController::showAction() — Method in class InspirationController

Show action

MyResearchController::shortLoansAction() — Method in class MyResearchController

Short loans action

MyResearchController::shortLoansAjaxAction() — Method in class MyResearchController

Send list of fines to view as HTML for rendering in AJAX

MyResearchController::shortLoans() — Method in class MyResearchController

Time slots controller plugin

MyResearchTrait::showException() — Method in class MyResearchTrait

Show the exception in the flash messenger

ShortLoansClass in namespace KnihovnyCz\Controller\Plugin

Support class for time slots

ShortLoans::sortSlots() — Method in class ShortLoans

Sort slots by start

RecordController::shortLoanAction() — Method in class RecordController

Short loan action.

RecordController::shortLoans() — Method in class RecordController

Time slots controller plugin

SearchControllerClass in namespace KnihovnyCz\Controller

Class SearchController

SearchController::setLanguage() — Method in class SearchController

Set up the translator language.

User::save() — Method in class User
Save
$ UserCard#savedProperty in class UserCard
UserList::setUsedLists() — Method in class UserList

Set used lists

$ UserSettings#saved_institutionsProperty in class UserSettings
UserSettings::setSavedInstitutions() — Method in class UserSettings

Get library prefixes from connected library cards

Aleph::supportsMethod() — Method in class Aleph

Helper method to determine whether or not a certain method can be called on this driver. Required method for any smart drivers.

$ KohaRest1905#statusesProperty in class KohaRest1905

Checkout statuses

MultiBackend::supportsMethod() — Method in class MultiBackend

Helper method to determine whether or not a certain method can be called on this driver. Required method for any smart drivers.

MultiBackend::siglaToSource() — Method in class MultiBackend

Takes sigla and return library source for it

MultiBackend::sourceToSigla() — Method in class MultiBackend

Library source to sigla

XCNCIP2::supportsMethod() — Method in class XCNCIP2

Helper method to determine whether or not a certain method can be called on this driver. Required method for any smart drivers.

SolrIdResolverClass in namespace KnihovnyCz\ILS\Service

Class SolrIdResolver

$ SolrIdResolver#searchServiceProperty in class SolrIdResolver

Search service (used for lookups by item identifiers)

SolrIdResolverFactoryClass in namespace KnihovnyCz\ILS\Service

Class SolrIdResolverFactory

$ InvolvedLibrariesBuilder#serviceProperty in class InvolvedLibrariesBuilder
InvolvedLibrariesBuilder::setConfiguration() — Method in class InvolvedLibrariesBuilder

Sets extension configuration

InvolvedLibrariesParser::setConfiguration() — Method in class InvolvedLibrariesParser

Set extension configuration

$ MapSelection#selectedMapScaleProperty in class MapSelection

Selected map scale - min and max value in array

MapSelection::setConfig() — Method in class MapSelection
SetConfig
RecommendOtherPortals::setConfig() — Method in class RecommendOtherPortals

Store the configuration of the recommendation module.

SideFacetsDeferredClass in namespace KnihovnyCz\Recommend

SideFacetsDeferred Recommendations Module

SideFacetsDeferred::setConfig() — Method in class SideFacetsDeferred

Store the configuration of the recommendation module.

SideFacetsDeferredFactoryClass in namespace KnihovnyCz\Recommend

SideFacets recommendation module factory.

$ WikidataTrait#sparqlServiceProperty in class WikidataTrait

Wikidata sparql connector

Search2LibraryClass in namespace KnihovnyCz\RecordDriver

Knihovny.cz solr library record driver

$ Search2Library#sourceIdentifierProperty in class Search2Library

Used for identifying search backends

SolrAuthorityClass in namespace KnihovnyCz\RecordDriver

Knihovny.cz solr authority record driver

SolrDefaultClass in namespace KnihovnyCz\RecordDriver

Knihovny.cz solr default record driver

SolrDefaultFactoryClass in namespace KnihovnyCz\RecordDriver

Class solr default record driver factory

SolrDictionaryClass in namespace KnihovnyCz\RecordDriver

Knihovny.cz solr dictionary record driver

SolrDublinCoreClass in namespace KnihovnyCz\RecordDriver

Class solr dublin core record driver

SolrLibraryClass in namespace KnihovnyCz\RecordDriver

Knihovny.cz solr library record driver

$ SolrLibrary#socialSitesProperty in class SolrLibrary
SolrLibraryFactoryClass in namespace KnihovnyCz\RecordDriver

Class SolrLibraryFactory

SolrLocalClass in namespace KnihovnyCz\RecordDriver

Knihovny.cz solr marc local record driver

SolrLocalFactoryClass in namespace KnihovnyCz\RecordDriver

Class SolrLocalFactory

SolrMarcClass in namespace KnihovnyCz\RecordDriver

Class solr marc record driver

SolrMarc::supportsAjaxStatus() — Method in class SolrMarc

Returns true if the record supports real-time AJAX status lookups.

SummonClass in namespace KnihovnyCz\RecordDriver

Class Summon

Summon::supportsOpenUrl() — Method in class Summon

Checks the current record if it's supported for generating OpenURLs.

SummonFactoryClass in namespace KnihovnyCz\RecordDriver

Class SummonFactory

SfxAvailabilityClass in namespace KnihovnyCz\RecordTab

Class SfxAvailability

StaffViewDublinCoreClass in namespace KnihovnyCz\RecordTab

Class StaffViewDublinCore

SolrFieldClass in namespace KnihovnyCz\Related

Class SolrField

Search2BackendFactoryClass in namespace KnihovnyCz\Search\Factory

Factory for a second Solr backend

SolrDefaultBackendFactoryClass in namespace KnihovnyCz\Search\Factory

Factory for the default SOLR backend.

$ SolrDefaultBackendFactory#siteConfigProperty in class SolrDefaultBackendFactory

Site configuration file identifier.

ParamBag::setApplyChildFilter() — Method in class ParamBag

Set appply child filter

SearchRunnerClass in namespace KnihovnyCz\Search

VuFind Search Runner

Connector::setRequest() — Method in class Connector

Set request

Connector::setPerformanceLogger() — Method in class Connector

Set performance logger

Connector::search() — Method in class Connector

Execute a search.

Connector::send() — Method in class Connector

Send request the SOLR and return the response.

Connector::switchToParentQuery() — Method in class Connector

Switch to parent query

HttpService::setCurlProxyOptions() — Method in class HttpService

Set proxy options in a Curl adapter.

$ UserSettingsService#sessionProperty in class UserSettingsService

Session container

UserSettingsService::save() — Method in class UserSettingsService

Save user settings

$ WayfFilterGenerator#shibbolethConfigProperty in class WayfFilterGenerator

Enabled identity providers

NullSessionManager::sessionExists() — Method in class NullSessionManager

Does a session exist and is it currently active?

NullSessionManager::start() — Method in class NullSessionManager

Start session

NullSessionManager::setName() — Method in class NullSessionManager

Attempt to set the session name

NullSessionManager::setId() — Method in class NullSessionManager

Set session ID

NullSessionManager::setValidatorChain() — Method in class NullSessionManager

Set the validator chain to use when validating a session

$ DatabaseCsrf#sessionIdProperty in class DatabaseCsrf

Session id

$ RecordLinker#searchConfigProperty in class RecordLinker

Search config

SearchTabsClass in namespace KnihovnyCz\View\Helper\KnihovnyCz

Class SearchTabs

SearchTabsFactoryClass in namespace KnihovnyCz\View\Helper\KnihovnyCz

Class SearchTabsFactory

SplitTextClass in namespace KnihovnyCz\View\Helper\KnihovnyCz

Class SplitText

SparqlServiceClass in namespace KnihovnyCz\Wikidata

Class SparqlService

$ SparqlService#sparqlUrlProperty in class SparqlService
SparqlServiceFactoryClass in namespace KnihovnyCz\Wikidata

Class SparqlServiceFactory

Ziskej::setMode() — Method in class Ziskej

Set mode to cookie

SolrAuthorityTestClass in namespace [Global Namespace]

Class SolrAuthorityTest

SolrLocalTestClass in namespace [Global Namespace]

Class SolrLocalTest

SolrMarcTestClass in namespace [Global Namespace]

Class SolrMarcTest

SocialstatsControllerClass in namespace VuFindAdmin\Controller

Class controls VuFind social statistical data.

Search2ApiControllerClass in namespace VuFindApi\Controller

Search2 API Controller

$ Search2ApiController#searchClassIdProperty in class Search2ApiController

Search class family to use.

$ Search2ApiController#searchRouteProperty in class Search2ApiController

Search route uri

Search2ApiControllerFactoryClass in namespace VuFindApi\Controller

Factory for Search2ApiController.

SearchApiControllerClass in namespace VuFindApi\Controller

Search API Controller

$ SearchApiController#searchAccessPermissionProperty in class SearchApiController

Permission required for the search endpoint

$ SearchApiController#searchRouteProperty in class SearchApiController

Search route uri

SearchApiController::searchAction() — Method in class SearchApiController

Search action

SearchApiControllerFactoryClass in namespace VuFindApi\Controller

Factory for SearchApiController.

$ WebApiController#searchClassIdProperty in class WebApiController

Search class family to use.

$ WebApiController#searchRouteProperty in class WebApiController

Search route uri

Search2RecordFormatterClass in namespace VuFindApi\Formatter

Record formatter for API responses

Search2RecordFormatterFactoryClass in namespace VuFindApi\Formatter

Record Formatter factory.

StaticRouteCommandClass in namespace VuFindConsole\Command\Generate

Console command: Generate static route.

$ WebCrawlCommand#solrProperty in class WebCrawlCommand

Solr writer

$ NotifyCommand#scheduleOptionsProperty in class NotifyCommand

Configured schedule options

$ NotifyCommand#searchTableProperty in class NotifyCommand

Search table

NotifyCommand::setLanguage() — Method in class NotifyCommand

Set up the translator language.

NotifyCommand::sendEmail() — Method in class NotifyCommand

Try to send an email message to a user. Return true on success, false on error.

$ AbstractSolrCommand#solrProperty in class AbstractSolrCommand

Solr writer

$ CommitCommand#solrCommandProperty in class CommitCommand

The name of the Solr command, for use in help messages.

$ OptimizeCommand#solrCommandProperty in class OptimizeCommand

The name of the Solr command, for use in help messages.

ScssBuilderCommandClass in namespace VuFindConsole\Command\Util

Console command: build CSS from SCSS.

ScssBuilderCommandFactoryClass in namespace VuFindConsole\Command\Util

Factory for Util/ScssBuilder command.

SitemapCommandClass in namespace VuFindConsole\Command\Util

Console command: generate sitemaps

SitemapCommandFactoryClass in namespace VuFindConsole\Command\Util

Factory for Util/SitemapCommand.

SuppressedCommandClass in namespace VuFindConsole\Command\Util

Console command: remove suppressed records from index

SwitchDbHashCommandClass in namespace VuFindConsole\Command\Util

Console command: switch database encryption algorithm.

SwitchDbHashCommandFactoryClass in namespace VuFindConsole\Command\Util

Factory for Util/SwitchDbHashCommand.

ConsoleOutputTrait::setOutputInterface() — Method in class ConsoleOutputTrait

Set the output interface. Implements a fluent interface.

LanguageHelper::summarizeData() — Method in class LanguageHelper

Create summary data for use in the tabular display.

AbstractBackend::setIdentifier() — Method in class AbstractBackend

Set the backend identifier.

AbstractBackend::setRecordCollectionFactory() — Method in class AbstractBackend

Set the record collection factory.

BackendInterface::setIdentifier() — Method in class BackendInterface

Set the backend identifier.

BackendInterface::search() — Method in class BackendInterface

Perform a search and return record collection.

Backend::search() — Method in class Backend

Perform a search and return record collection.

Backend::setEventManager() — Method in class Backend

Set EventManager instance.

RecordCollection::setSourceIdentifier() — Method in class RecordCollection

Set the source backend identifier.

Backend::search() — Method in class Backend

Perform a search and return record collection.

Backend::setQueryBuilder() — Method in class Backend

Set the query builder.

Connector::search() — Method in class Connector

Perform a search

ApiException::setApiError() — Method in class ApiException

Set the api error details into an array

$ Backend#sessionProperty in class Backend

Session container

Backend::search() — Method in class Backend

Perform a search and return record collection.

Backend::setQueryBuilder() — Method in class Backend

Set the query builder.

Backend::setAuthManager() — Method in class Backend

Set the VuFind Authentication Manager

$ Base#searchHttpMethodProperty in class Base

Search HTTP method

Base::search() — Method in class Base

Execute an EdsApi search

Base::setTokens() — Method in class Base

Populate an associative array of session and authentication parameters to send to the EDS API

RecordCollection::setFacets() — Method in class RecordCollection

Set facets.

SearchRequestModelClass in namespace VuFindSearch\Backend\EDS

EBSCO EDS API Search Model

$ SearchRequestModel#sortProperty in class SearchRequestModel

Sort option to apply

$ SearchRequestModel#searchModeProperty in class SearchRequestModel

Mode to be effective in the search

SearchRequestModel::setParameters() — Method in class SearchRequestModel

Set properties from parameters

Backend::search() — Method in class Backend

Perform a search and return record collection.

Backend::setQueryBuilder() — Method in class Backend

Set the query builder.

Connector::search() — Method in class Connector

Execute a search.

ConnectorCacheTrait::setCache() — Method in class ConnectorCacheTrait

Set the cache storage

Backend::search() — Method in class Backend

Perform a search and return record collection.

Backend::setQueryBuilder() — Method in class Backend

Set the query builder.

Backend::setMaxQueryTime() — Method in class Backend

Set the max query time.

Backend::setSearchProgressTarget() — Method in class Backend

Set the search progress target.

Backend::search() — Method in class Backend

Perform a search and return record collection.

Backend::setQueryBuilder() — Method in class Backend

Set the query builder.

$ Connector#sessionProperty in class Connector

Session ID

Connector::send() — Method in class Connector

Send a request and return the response.

Connector::search() — Method in class Connector

Launches a search.

Connector::session() — Method in class Connector

Return session id

Connector::settings() — Method in class Connector

Applies settings to this session Each setting parameter has the form name[target]=value

Connector::show() — Method in class Connector

Proper alias of results

Connector::stat() — Method in class Connector

Provides status information about an ongoing search.

Backend::search() — Method in class Backend

Perform a search and return record collection.

Backend::setQueryBuilder() — Method in class Backend

Set the query builder.

RecordCollection::setFacets() — Method in class RecordCollection

Set facets.

$ Connector#sruVersionProperty in class Connector

The version to specify in the URL

Connector::scan() — Method in class Connector
Scan
Connector::sruSearch() — Method in class Connector
Search
$ Backend#similarBuilderProperty in class Backend

Similar records query builder.

Backend::setPageSize() — Method in class Backend

Set the limit for batch queries

Backend::search() — Method in class Backend

Perform a search and return record collection.

Backend::similar() — Method in class Backend

Return similar records.

Backend::setQueryBuilder() — Method in class Backend

Set the query builder.

Backend::setSimilarBuilder() — Method in class Backend

Set the similar records query builder.

Connector::similar() — Method in class Connector

Return records similar to a given record specified by id.

Connector::search() — Method in class Connector

Execute a search.

Connector::send() — Method in class Connector

Send request the SOLR and return the response.

HandlerMap::setHandlerMap() — Method in class HandlerMap

Set the handler map.

HandlerMap::setParameters() — Method in class HandlerMap

Set handler defaults, appends, or invariants.

$ QueryBuilder#specsProperty in class QueryBuilder

Search specs.

QueryBuilder::setFieldsToHighlight() — Method in class QueryBuilder

Set list of fields to highlight, if any (or '*' for all). Set to an empty string (the default) to completely disable highlighting-related functionality.

QueryBuilder::setCreateSpellingQuery() — Method in class QueryBuilder

Control whether or not the QueryBuilder should create a spellcheck.q parameter. (Turned off by default).

QueryBuilder::setSpecs() — Method in class QueryBuilder

Set query builder search specs.

QueryBuilder::setLuceneHelper() — Method in class QueryBuilder

Set Lucene syntax helper

QueryBuilderInterface::setCreateSpellingQuery() — Method in class QueryBuilderInterface

Control whether or not the QueryBuilder should create a spellcheck.q parameter. (Turned off by default).

SerializableRecordClass in namespace VuFindSearch\Backend\Solr\Record

SOLR serializable record definition.

SerializableRecordInterfaceClass in namespace VuFindSearch\Backend\Solr\Record

SOLR serializable record interface definition.

$ RecordCollection#spellcheckProperty in class RecordCollection

Spellcheck information.

RecordCollection::setFacets() — Method in class RecordCollection

Set facets.

SpellcheckClass in namespace VuFindSearch\Backend\Solr\Response\Json

SOLR spellcheck information.

$ Spellcheck#secondaryProperty in class Spellcheck

Secondary spelling suggestions (in case merged results are not useful).

SearchHandlerClass in namespace VuFindSearch\Backend\Solr

VuFind SearchHandler.

$ SearchHandler#specsProperty in class SearchHandler

Search handler specification.

SearchHandler::setDefaultMustMatch() — Method in class SearchHandler

Support method for constructor: if no mm is provided, set a reasonable default based on the selected Dismax handler.

SimilarBuilderClass in namespace VuFindSearch\Backend\Solr

SOLR SimilarBuilder.

SimilarBuilderInterfaceClass in namespace VuFindSearch\Backend\Solr

SOLR SimilarBuilder interface definition.

Backend::search() — Method in class Backend

Perform a search and return record collection.

Backend::setQueryBuilder() — Method in class Backend

Set the query builder.

BackendTest::setUp() — Method in class BackendTest

Setup method.

QueryBuilder::setLuceneHelper() — Method in class QueryBuilder

Set Lucene syntax helper

Backend::search() — Method in class Backend

Perform a search and return record collection.

Backend::setQueryBuilder() — Method in class Backend

Set the query builder.

Connector::search() — Method in class Connector

Execute a search.

AbstractBase::setTargetIdentifier() — Method in class AbstractBase

Set target backend identifier.

AbstractBase::setSearchParameters() — Method in class AbstractBase

Set search parameters.

AbstractBase::setContext() — Method in class AbstractBase

Set command context.

$ AlphabeticBrowseCommand#sourceProperty in class AlphabeticBrowseCommand

Name of index to search.

QueryOffsetLimitTrait::setQuery() — Method in class QueryOffsetLimitTrait

Set search query.

QueryOffsetLimitTrait::setOffset() — Method in class QueryOffsetLimitTrait

Set search offset.

QueryOffsetLimitTrait::setLimit() — Method in class QueryOffsetLimitTrait

Set search limit.

SearchCommandClass in namespace VuFindSearch\Command

Perform a search and return record collection command.

SetRecordCollectionFactoryCommandClass in namespace VuFindSearch\Command

Perform a search and return record collection command.

SimilarCommandClass in namespace VuFindSearch\Command

Return similar records command.

$ TermsCommand#startProperty in class TermsCommand

Starting term.

SimilarInterfaceClass in namespace VuFindSearch\Feature

MLT feature interface definition.

SimilarInterface::similar() — Method in class SimilarInterface

Return similar records.

ParamBag::set() — Method in class ParamBag

Set a parameter.

Query::setString() — Method in class Query

Set the search string.

Query::setHandler() — Method in class Query

Set name of search handler.

Query::setOperator() — Method in class Query

Set operator (null if n/a).

QueryGroup::setReducedHandler() — Method in class QueryGroup

Set name of reduced handler.

QueryGroup::setQueries() — Method in class QueryGroup

Set group queries.

QueryGroup::setOperator() — Method in class QueryGroup

Set boolean operator.

$ AbstractRecordCollection#sourceProperty in class AbstractRecordCollection

Source identifier

AbstractRecordCollection::shuffle() — Method in class AbstractRecordCollection

Shuffles records.

AbstractRecordCollection::slice() — Method in class AbstractRecordCollection

Slice the record list.

AbstractRecordCollection::setSourceIdentifier() — Method in class AbstractRecordCollection

Set the source backend identifier.

AbstractRecordCollection::setSourceIdentifiers() — Method in class AbstractRecordCollection

Set the source backend identifiers.

RecordCollectionInterface::setSourceIdentifier() — Method in class RecordCollectionInterface

Set the source backend identifier.

RecordCollectionInterface::setSourceIdentifiers() — Method in class RecordCollectionInterface

Set the source backend identifiers.

RecordInterface::setSourceIdentifier() — Method in class RecordInterface

Set the source backend identifier.

RecordInterface::setSourceIdentifiers() — Method in class RecordInterface

Set the source backend identifiers.

RecordInterface::setLabels() — Method in class RecordInterface

Set the labels for the record

$ RecordTrait#sourceIdentifierProperty in class RecordTrait

Used for identifying record source backend

$ RecordTrait#searchBackendIdentifierProperty in class RecordTrait

Used for identifying the search backend used to find the record

RecordTrait::setSourceIdentifier() — Method in class RecordTrait

Set the record source backend identifier.

RecordTrait::setSourceIdentifiers() — Method in class RecordTrait

Set the source backend identifiers.

RecordTrait::setLabels() — Method in class RecordTrait

Set the labels for the record

SimpleRecordClass in namespace VuFindSearch\Response

A minimal record class for wrapping an array of fields

ServiceClass in namespace VuFindSearch

Search service.

Service::setEventManager() — Method in class Service

Set EventManager instance.

DoiLookupTest::setupConfig() — Method in class DoiLookupTest

Set up configuration for a test.

DoiLookupTest::setupPluginManager() — Method in class DoiLookupTest

Set up a plugin manager for a test.

DatabaseTest::setUpBeforeClass() — Method in class DatabaseTest

Standard setup method.

DatabaseTest::setUp() — Method in class DatabaseTest

Standard setup method.

ILSTest::setUpBeforeClass() — Method in class ILSTest

Standard setup method.

ILSTest::setUp() — Method in class ILSTest

Standard setup method.

MultiILSTest::setUp() — Method in class MultiILSTest

Standard setup method.

SIP2TestClass in namespace VuFindTest\Auth

SIP2 authentication test class.

ShibbolethTestClass in namespace VuFindTest\Auth

Shibboleth authentication test class.

ShibbolethTest::setUpBeforeClass() — Method in class ShibbolethTest

Standard setup method.

ShibbolethTest::setUp() — Method in class ShibbolethTest

Standard setup method.

SolrTestClass in namespace VuFindTest\Autocomplete

Solr autocomplete test class.

$ BackendTest#sharedEventManagerProperty in class BackendTest

Event manager

BackendTest::setUp() — Method in class BackendTest

Standard setup method.

SpellcheckTestClass in namespace VuFindTest\Backend\Solr\Json\Response

Unit tests for spellcheck information.

SerializableRecordTestClass in namespace VuFindTest\Backend\Solr\Record

Unit tests for SOLR serializable record.

SearchHandlerTestClass in namespace VuFindTest\Backend\Solr

Unit tests for SOLR search handler.

SimilarBuilderTestClass in namespace VuFindTest\Backend\Solr

Unit tests for SOLR similar records query builder

ScopusTestClass in namespace VuFindTest\CSV\ImportHelper

Scopus CSV Import helper test class.

ImporterTest::setUp() — Method in class ImporterTest

Setup method.

CartTest::setUp() — Method in class CartTest

Standard setup method.

RandomTest::setUpTestInputsAndExpectations() — Method in class RandomTest

Support method to mock objects.

SimilarItemsTestClass in namespace VuFindTest\ChannelProvider

SimilarItems Test Class

StaticRouteCommandTestClass in namespace VuFindTest\Command\Generate

Generate/StaticRoute command test.

AddUsingTemplateCommandTest::setUp() — Method in class AddUsingTemplateCommandTest

Standard setup method.

CopyStringCommandTest::setUp() — Method in class CopyStringCommandTest

Standard setup method.

DeleteCommandTest::setUp() — Method in class DeleteCommandTest

Standard setup method.

NormalizeCommandTest::setUp() — Method in class NormalizeCommandTest

Standard setup method.

NotifyCommandTest::setup() — Method in class NotifyCommandTest

Setup method

SearchCommandTestClass in namespace VuFindTest\Command

Unit tests for SearchCommand.

SetRecordCollectionFactoryCommandTestClass in namespace VuFindTest\Command

Unit tests for SetRecordCollectionFactoryCommand.

SimilarCommandTestClass in namespace VuFindTest\Command

Unit tests for SimilarCommand.

DedupeCommandTest::setSuccessfulExpectations() — Method in class DedupeCommandTest

Set up basic expectations on a command.

ScssBuilderCommandTestClass in namespace VuFindTest\Command\Util

ScssBuilderCommand test.

SitemapCommandTestClass in namespace VuFindTest\Command\Util

SitemapCommand test.

SuppressedCommandTestClass in namespace VuFindTest\Command\Util

SuppressedCommand test.

SwitchDbHashCommandTestClass in namespace VuFindTest\Command\Util

SwitchDbHashCommand test.

SwitchDbHashCommandTest::setUp() — Method in class SwitchDbHashCommandTest

Standard setup method.

$ PathResolverTest#stackedResolverProperty in class PathResolverTest

Stacked path resolver

PathResolverTest::setUp() — Method in class PathResolverTest

Setup method.

PluginFactoryTest::setUp() — Method in class PluginFactoryTest

Standard setup method.

SearchSpecsReaderTestClass in namespace VuFindTest\Config

Config SearchSpecsReader Test Class

MockContainerTrait::set() — Method in class MockContainerTrait

Explicitly set an entry in the container.

SummonTestClass in namespace VuFindTest\Content\Covers

Unit tests for Summon cover loader.

HoldsTest::setUp() — Method in class HoldsTest

Standard setup method.

SocialstatsControllerTestClass in namespace VuFindTest\Controller

Unit tests for Socialstats controller.

ContainerTest::setUp() — Method in class ContainerTest

Setup method: establish Container.

CssPreCompilerTest::setUpBeforeClass() — Method in class CssPreCompilerTest

Initial class setup.

CssPreCompilerTest::setUp() — Method in class CssPreCompilerTest

Individual test setup.

CssPreCompilerTest::setupCompiler() — Method in class CssPreCompilerTest

Assign appropriate values to $this->testDest and $this->compiler

ChangeTrackerTest::setUp() — Method in class ChangeTrackerTest

Standard setup method.

DemoDriverTestTrait::submitCatalogLoginForm() — Method in class DemoDriverTestTrait

Fill in and submit the catalog login form with the provided credentials.

ReflectionTrait::setProperty() — Method in class ReflectionTrait

Set protected or private property.

SearchServiceTraitClass in namespace VuFindTest\Feature

Mix-in for constructing the search service for tests.

SolrSearchObjectTraitClass in namespace VuFindTest\Feature

Mix-in for constructing Solr search objects for tests.

UserCreationTrait::submitLoginForm() — Method in class UserCreationTrait

Submit the login form (assuming it's open).

SorterTestClass in namespace VuFindTest\I18n

Class SorterTest

SorterTest::sortProvider() — Method in class SorterTest

Data Provider for sort tests

AlephTest::setUp() — Method in class AlephTest

Standard setup method.

AmicusTest::setUp() — Method in class AmicusTest

Standard setup method.

DAIATest::setUp() — Method in class DAIATest

Standard setup method.

DemoTest::setUp() — Method in class DemoTest

Standard setup method.

EvergreenTest::setUp() — Method in class EvergreenTest

Standard setup method.

GeniePlusTest::setUp() — Method in class GeniePlusTest

Standard setup method.

GeniePlusTest::setUpHoldingTest() — Method in class GeniePlusTest

Configure the driver to respond to a getHolding() call.

HorizonTest::setUp() — Method in class HorizonTest

Standard setup method.

HorizonXMLAPITest::setUp() — Method in class HorizonXMLAPITest

Standard setup method.

InnovativeTest::setUp() — Method in class InnovativeTest

Standard setup method.

KohaILSDITest::setUp() — Method in class KohaILSDITest

Standard setup method.

KohaTest::setUp() — Method in class KohaTest

Standard setup method.

NewGenLibTest::setUp() — Method in class NewGenLibTest

Standard setup method.

NoILSTest::setUp() — Method in class NoILSTest

Standard setup method.

$ PAIATest#storageRetrievalTestResultProperty in class PAIATest
PAIATest::setUp() — Method in class PAIATest

Standard setup method.

PolarisTest::setUp() — Method in class PolarisTest

Standard setup method.

SampleTestClass in namespace VuFindTest\ILS\Driver

ILS driver test

SampleTest::setUp() — Method in class SampleTest

Standard setup method.

SierraRestTestClass in namespace VuFindTest\ILS\Driver

SierraRest ILS driver test

SierraRestTest::setUp() — Method in class SierraRestTest

Standard setup method.

SymphonyTestClass in namespace VuFindTest\ILS\Driver

ILS driver test

SymphonyTest::setUp() — Method in class SymphonyTest

Standard setup method.

UnicornTest::setUp() — Method in class UnicornTest

Standard setup method.

VirtuaTest::setUp() — Method in class VirtuaTest

Standard setup method.

VoyagerNoSupportMock::supportsMethod() — Method in class VoyagerNoSupportMock
VoyagerRestfulTest::setUp() — Method in class VoyagerRestfulTest

Standard setup method.

VoyagerTest::setUp() — Method in class VoyagerTest

Standard setup method.

$ XCNCIP2Test#storageRetrievalTestsProperty in class XCNCIP2Test

Test definition for testGetMyStorageRetrievalRequests

$ XCNCIP2Test#statusesTestsProperty in class XCNCIP2Test

Test definition for testGetStatuses

XCNCIP2Test::setUp() — Method in class XCNCIP2Test

Standard setup method.

SolrAuthTestClass in namespace VuFindTest\Integration\Connection

Solr Auth Test Class

SolrAuthTest::setUp() — Method in class SolrAuthTest

Standard setup method.

SolrTestClass in namespace VuFindTest\Integration\Connection

Solr Connection Test Class

SolrTest::setUp() — Method in class SolrTest

Standard setup method.

$ MinkTestCase#sessionProperty in class MinkTestCase

Mink session

MinkTestCase::snooze() — Method in class MinkTestCase

Sleep if necessary.

MinkTestCase::stopMinkSession() — Method in class MinkTestCase

Shut down the Mink session.

MinkTestCase::setUp() — Method in class MinkTestCase

Standard setup method.

ResultFeedTest::setUp() — Method in class ResultFeedTest

Standard setup method.

SlackTestClass in namespace VuFindTest\Log\Writer

Slack Log Writer Test Class

AccountActionsTest::setUpBeforeClass() — Method in class AccountActionsTest

Standard setup method.

AccountMenuTest::setUpBeforeClass() — Method in class AccountMenuTest

Standard setup method.

AccountMenuTest::setUp() — Method in class AccountMenuTest

Standard setup + login

AccountMenuTest::setJSStorage() — Method in class AccountMenuTest

Create a specific state in the account ajax storage.

AccountMenuTest::setUpFinesEnvironment() — Method in class AccountMenuTest

Establish the fines in the session that will be used by various tests below.

BulkTest::setUpBeforeClass() — Method in class BulkTest

Standard setup method.

BulkTest::setUpGenericBulkTest() — Method in class BulkTest

Set up a generic bulk test by configuring VuFind to include bulk options and then running a search.

CallnumberBrowseTest::setupMultipleCallnumbers() — Method in class CallnumberBrowseTest
CartTest::setUpBeforeClass() — Method in class CartTest

Standard setup method.

CartTest::setUpGenericCartTest() — Method in class CartTest

Set up a generic cart test by running a search and putting its results into the cart, then opening the lightbox so that additional actions may be attempted.

CartTest::selectAllItemsInCart() — Method in class CartTest

Select all of the items currently in the cart lightbox.

ChoiceAuthTest::setUpBeforeClass() — Method in class ChoiceAuthTest

Standard setup method.

FavoritesTest::setUpBeforeClass() — Method in class FavoritesTest

Standard setup method.

FavoritesTest::stripHash() — Method in class FavoritesTest

Strip off the hash segment of a URL.

FavoritesTest::setupBulkTest() — Method in class FavoritesTest

Adjust configs for bulk testing, then go to user account.

FavoritesTest::selectAllItemsInList() — Method in class FavoritesTest

Select all of the items currently in the cart lightbox.

FeedbackTest::setupPage() — Method in class FeedbackTest

Set up the page for testing.

HoldsTest::setUpBeforeClass() — Method in class HoldsTest

Standard setup method.

HoldsTest::setUpFrozenHold() — Method in class HoldsTest

Create a frozen hold and navigate to the holds list. Return the page object that was set up during the process.

IlsActionsTest::setUpBeforeClass() — Method in class IlsActionsTest

Standard setup method.

IlsActionsTest::storageRetrievalRequestProcedure() — Method in class IlsActionsTest

Routine to place a storage retrieval request

IlsActionsTest::setUpCancelIllTest() — Method in class IlsActionsTest

Set up a cancel ILL request test.

IlsActionsTest::setUpCancelStorageRetrievalTest() — Method in class IlsActionsTest

Set up a cancel storage retrieval request test.

LinkResolverTest::setupRecordPage() — Method in class LinkResolverTest

Set up the record page for OpenURL testing.

ListViewsTest::setUpBeforeClass() — Method in class ListViewsTest

Standard setup method.

OAuth2Test::setUpBeforeClass() — Method in class OAuth2Test

Standard setup method.

OAuth2Test::setUp() — Method in class OAuth2Test

Standard setup method.

OAuth2Test::setUpTest() — Method in class OAuth2Test

Set up a test

RecordActionsTest::setUpBeforeClass() — Method in class RecordActionsTest

Standard setup method.

SavedSearchesTestClass in namespace VuFindTest\Mink

Mink saved searches test class.

SavedSearchesTest::setUpBeforeClass() — Method in class SavedSearchesTest

Standard setup method.

SearchFacetsTestClass in namespace VuFindTest\Mink

Mink search facet/filter functionality test class.

SearchLimitTestClass in namespace VuFindTest\Mink

Test for search limits.

SearchLimitTest::setUpLimitedSearch() — Method in class SearchLimitTest

Set up a search page with limits configured

ShibbolethLogoutNotificationTestClass in namespace VuFindTest\Mink

Shibboleth logout notification test class.

ServerTestClass in namespace VuFindTest\OAI

OAI-PMH server unit test.

IdentityRepositoryTest::setUp() — Method in class IdentityRepositoryTest

Setup tests

ScopeRepositoryTestClass in namespace VuFindTest\OAuth2\Repository

OAuth2 ScopeRepository tests.

RandomRecommendTest::setUp() — Method in class RandomRecommendTest

Standard setup method.

$ RecommendLinksTest#sampleLinksProperty in class RecommendLinksTest

Test configuration data.

SideFacetsTestClass in namespace VuFindTest\Recommend

SideFacets recommendation module Test Class

SummonBestBetsDeferredTestClass in namespace VuFindTest\Recommend

SummonBestBetsDeferred recommendation module Test Class

SummonBestBetsTestClass in namespace VuFindTest\Recommend

SummonBestBets Test Class

SummonDatabasesDeferredTestClass in namespace VuFindTest\Recommend

SummonDatabasesDeferred recommendation module Test Class

SummonDatabasesTestClass in namespace VuFindTest\Recommend

SummonDatabases Test Class

SummonResultsDeferredTestClass in namespace VuFindTest\Recommend

SummonResultsDeferred recommendation module Test Class

SummonResultsTestClass in namespace VuFindTest\Recommend

SummonResults Test Class

SummonTopicsTestClass in namespace VuFindTest\Recommend

SummonTopics Test Class

SwitchQueryTestClass in namespace VuFindTest\Recommend

SwitchQuery recommendation module Test Class

SwitchTabTestClass in namespace VuFindTest\Recommend

SwitchTab Test Class

SwitchTypeTestClass in namespace VuFindTest\Recommend

SwitchType Test Class

SolrAuthMarcTestClass in namespace VuFindTest\RecordDriver

SolrAuthMarc Record Driver Test Class

SolrDefaultTestClass in namespace VuFindTest\RecordDriver

SolrDefault Record Driver Test Class

SolrMarcRemoteTestClass in namespace VuFindTest\RecordDriver

SolrMarcRemote Record Driver Test Class

SolrMarcTestClass in namespace VuFindTest\RecordDriver

SolrMarc Record Driver Test Class

SolrOverdriveTestClass in namespace VuFindTest\RecordDriver

SolrOverdrive Record Driver Test Class

SimilarItemsCarouselTestClass in namespace VuFindTest\RecordTab

SimilarItemsCarousel Test Class

StaffViewArrayTestClass in namespace VuFindTest\RecordTab

StaffViewArray Test Class

StaffViewMARCTestClass in namespace VuFindTest\RecordTab

StaffViewMARC Test Class

StaffViewOverdriveTestClass in namespace VuFindTest\RecordTab

Staff view (array dump) Test Class

CacheTest::setUp() — Method in class CacheTest

Set up everything for testing

SolrTestClass in namespace VuFindTest\Record\FallbackLoader

Solr fallback loader test.

SummonTestClass in namespace VuFindTest\Record\FallbackLoader

Summon fallback loader test.

SourceAndIdListTestClass in namespace VuFindTest\Record

SourceAndIdList tests.

SimilarTestClass in namespace VuFindTest\Related

Similar Related Items Test Class

SimpleRecordTestClass in namespace VuFindTest\Response

Unit tests for SimpleRecord class.

ServerParamTestClass in namespace VuFindTest\Role\PermissionProvider

PermissionProvider ServerParam Test Class

ShibbolethTestClass in namespace VuFindTest\Role\PermissionProvider

PermissionProvider Shibboleth Test Class

ClickatellTest::setUp() — Method in class ClickatellTest

Setup method

SearchServiceTestClass in namespace VuFindTest

Unit tests for search service.

OnCampusListenerTest::setUp() — Method in class OnCampusListenerTest
Setup.
PrimoPermissionHandlerTest::setUp() — Method in class PrimoPermissionHandlerTest
Setup.
SearchNormalizerTestClass in namespace VuFindTest\Search

SearchNormalizer unit tests.

SearchTabsHelperTestClass in namespace VuFindTest\Search

SearchTabsHelper unit tests.

$ ConditionalFilterListenerTest#searchConfigProperty in class ConditionalFilterListenerTest

Sample configuration for ConditionalFilters.

ConditionalFilterListenerTest::setUp() — Method in class ConditionalFilterListenerTest
Setup.
HierarchicalFacetHelperTest::setUp() — Method in class HierarchicalFacetHelperTest
Setup.
HierarchicalFacetHelperTest::setApplied() — Method in class HierarchicalFacetHelperTest

Set 'isApplied' to true in facet item with the given value

$ MultiIndexListenerTest#specsProperty in class MultiIndexListenerTest

Specs used for stripping tests.

$ MultiIndexListenerTest#shardsProperty in class MultiIndexListenerTest

Available shards used for stripping tests.

MultiIndexListenerTest::setUp() — Method in class MultiIndexListenerTest
Setup.
ParamsTest::sortValueProvider() — Method in class ParamsTest

Data provider for testSortTieBreakerParameter.

SpellingProcessorTestClass in namespace VuFindTest\Search\Solr

Unit tests for spelling processor.

FileTest::setUp() — Method in class FileTest

Generic setup method

SimpleXMLTestClass in namespace VuFindTest

SimpleXML Test Class

GeneratorTest::setUp() — Method in class GeneratorTest

Standard setup method.

ContentPagesTest::setUp() — Method in class ContentPagesTest

Standard setup method.

StartPageTestClass in namespace VuFindTest\Sitemap\Plugin

StartPage Plugin Test Class

SitemapIndexTestClass in namespace VuFindTest\Sitemap

SitemapIndex Test Class

SitemapTestClass in namespace VuFindTest\Sitemap

Sitemap Test Class

TagsTest::setUp() — Method in class TagsTest

Standard setup method.

ThemeCompilerTest::setUp() — Method in class ThemeCompilerTest

Standard setup method.

ThemeInfoTest::setUp() — Method in class ThemeInfoTest
Constructor
AjaxHandlerTest::setUp() — Method in class AjaxHandlerTest

Standard setup method.

SessionHandlerTestCaseClass in namespace VuFindTest\Unit

Abstract base class for session handler test cases.

SessionHandlerTestCase::setUpDestroyExpectations() — Method in class SessionHandlerTestCase

Set up expectations for the standard abstract handler's destroy behavior.

VuFindHighlighterTest::setUp() — Method in class VuFindHighlighterTest
SessionCsrfTestClass in namespace VuFindTest\Validator

CSRF Test Class

ParentTemplateTest::setUp() — Method in class ParentTemplateTest
Constructor
CurrencyFormatterTest::setUp() — Method in class CurrencyFormatterTest

Standard setup method

LinkifyTest::setUp() — Method in class LinkifyTest

Setup method

SpecBuilderTestClass in namespace VuFindTest\View\Helper\Root\RecordDataFormatter

RecordDataFormatter spec builder Test Class

RecordTest::setSuccessTemplate() — Method in class RecordTest

Set up expectations for a template

SafeMoneyFormatTestClass in namespace VuFindTest\View\Helper\Root

SafeMoneyFormat view helper Test Class

SafeMoneyFormatTest::setUp() — Method in class SafeMoneyFormatTest

Standard setup method

SearchMemoryTestClass in namespace VuFindTest\View\Helper\Root

SearchMemory view helper Test Class

SearchTabsTestClass in namespace VuFindTest\View\Helper\Root

SearchTabs view helper Test Class

ShortenUrlTestClass in namespace VuFindTest\View\Helper\Root

ShortenUrl view helper Test Class

SetupThemeResourcesTestClass in namespace VuFindTest\View\Helper

SetupThemeResources view helper Test Class

SlotTestClass in namespace VuFindTest\View\Helper

HeadThemeResources view helper Test Class

TemplatePathTest::setUp() — Method in class TemplatePathTest
Constructor
AbstractCssPreCompiler::setBasePath() — Method in class AbstractCssPreCompiler

Set base path

AbstractCssPreCompiler::setTempPath() — Method in class AbstractCssPreCompiler

Set temporary directory

AbstractThemeUtility::setLastError() — Method in class AbstractThemeUtility

Set last error message and return a boolean false.

GeneratorInterface::setOutputInterface() — Method in class GeneratorInterface

Set the output interface. Implements a fluent interface.

$ Initializer#serviceManagerProperty in class Initializer

Top-level service container

Initializer::sendThemeOptionsToView() — Method in class Initializer

Make the theme options available to the view.

Initializer::setUpThemeViewHelpers() — Method in class Initializer

Support method for setUpThemes -- register view helpers.

Initializer::setUpThemes() — Method in class Initializer

Support method for init() -- set up theme once current settings are known.

ResourceContainer::setEncoding() — Method in class ResourceContainer

Set the encoding.

ResourceContainer::setFavicon() — Method in class ResourceContainer

Set the favicon.

ResourceContainer::setGenerator() — Method in class ResourceContainer

Set the generator.

ScssCompilerClass in namespace VuFindTheme

Class to compile SCSS into CSS within a theme.

$ ThemeInfo#safeThemeProperty in class ThemeInfo

A safe theme (guaranteed to exist) that can be loaded if an invalid configuration is passed in

ThemeInfo::setCache() — Method in class ThemeInfo

Provide cache and activate info caching

ThemeInfo::setTheme() — Method in class ThemeInfo

Set the current theme.

ConcatTrait::setResourceFilePath() — Method in class ConcatTrait

Set the file path of the element object

HeadLink::setResourceFilePath() — Method in class HeadLink

Set the file path of the link object Required by ConcatTrait

HeadScript::setResourceFilePath() — Method in class HeadScript

Set the file path of the script object Required by ConcatTrait

SetupThemeResourcesClass in namespace VuFindTheme\View\Helper

View helper for loading theme-related resources.

SetupThemeResourcesFactoryClass in namespace VuFindTheme\View\Helper

Factory for SetupThemeResources view helper.

SlotClass in namespace VuFindTheme\View\Helper

Slot view helper

$ Slot#stackProperty in class Slot

Call stack to handle nested slots

Slot::set() — Method in class Slot

Set current value of slot but only if unset.

Slot::start() — Method in class Slot

Starts a buffer capture to override the value of a block.

$ AbstractBase#sessionSettingsProperty in class AbstractBase

Session settings

$ CheckRequestIsValid#statusesProperty in class CheckRequestIsValid

Status messages

$ GetACSuggestions#suggesterProperty in class GetACSuggestions

Autocomplete suggester

$ GetSideFacets#searchRunnerProperty in class GetSideFacets

Search runner

GetUserTransactions::setPaginationHelper() — Method in class GetUserTransactions

Set the ILS pagination helper

$ KeepAlive#sessionManagerProperty in class KeepAlive

Session Manager

SystemStatusClass in namespace VuFind\AjaxHandler

"Keep Alive" AJAX handler

$ SystemStatus#sessionManagerProperty in class SystemStatus

Session Manager

$ SystemStatus#sessionTableProperty in class SystemStatus

Session database table

SystemStatusFactoryClass in namespace VuFind\AjaxHandler

Factory for SystemStatus AJAX handler.

AbstractBase::setConfig() — Method in class AbstractBase

Set configuration.

AbstractBase::supportsCreation() — Method in class AbstractBase

Does this authentication method support account creation?

AbstractBase::supportsPasswordChange() — Method in class AbstractBase

Does this authentication method support password changing

AbstractBase::supportsPasswordRecovery() — Method in class AbstractBase

Does this authentication method support password recovery

AbstractBase::supportsConnectingLibraryCard() — Method in class AbstractBase

Does this authentication method support connecting library card of currently authenticated user?

CAS::setupCAS() — Method in class CAS

Establishes phpCAS Configuration and Enables the phpCAS Client

$ ChoiceAuth#strategiesProperty in class ChoiceAuth

Authentication strategies to present

$ ChoiceAuth#strategyProperty in class ChoiceAuth

Auth strategy selected by user

$ ChoiceAuth#sessionProperty in class ChoiceAuth

Session container

ChoiceAuth::setConfig() — Method in class ChoiceAuth

Set configuration; throw an exception if it is invalid.

ChoiceAuth::setPluginManager() — Method in class ChoiceAuth

Set the manager for loading other authentication plugins.

ChoiceAuth::supportsPasswordChange() — Method in class ChoiceAuth

Does this authentication method support password changing

ChoiceAuth::supportsPasswordRecovery() — Method in class ChoiceAuth

Does this authentication method support password recovery

ChoiceAuth::setStrategyFromRequest() — Method in class ChoiceAuth

Set the active strategy based on the auth_method value in the request, if found.

Database::supportsCreation() — Method in class Database

Does this authentication method support account creation?

Database::supportsPasswordChange() — Method in class Database

Does this authentication method support password changing

Database::supportsPasswordRecovery() — Method in class Database

Does this authentication method support password recovery

$ EmailAuthenticator#sessionManagerProperty in class EmailAuthenticator

Session Manager

EmailAuthenticator::sendAuthenticationLink() — Method in class EmailAuthenticator

Send an email authentication link to the specified email address.

$ Facebook#sessionProperty in class Facebook

Session container

ILS::setCatalog() — Method in class ILS

Set the ILS connection for this object.

ILS::supportsPasswordChange() — Method in class ILS

Does this authentication method support password changing

ILSAuthenticator::storedCatalogLogin() — Method in class ILSAuthenticator

Log the current user into the catalog using stored credentials; if this fails, clear the user's stored credentials so they can enter new, corrected ones.

ILSAuthenticator::sendEmailLoginLink() — Method in class ILSAuthenticator

Send email authentication link

$ Manager#sessionProperty in class Manager

Session container

$ Manager#sessionManagerProperty in class Manager

Session manager

Manager::supportsCreation() — Method in class Manager

Does the current configuration support account creation?

Manager::supportsRecovery() — Method in class Manager

Does the current configuration support password recovery?

Manager::supportsEmailChange() — Method in class Manager

Is email changing currently allowed?

Manager::supportsPasswordChange() — Method in class Manager

Is new passwords currently allowed?

Manager::supportsConnectingLibraryCard() — Method in class Manager

Is connecting library card allowed and supported?

Manager::setAuthMethod() — Method in class Manager
Setter
MultiAuth::setConfig() — Method in class MultiAuth

Set configuration; throw an exception if it is invalid.

MultiAuth::setPluginManager() — Method in class MultiAuth

Set the manager for loading other authentication plugins.

MultiILS::setCatalog() — Method in class MultiILS

Set the ILS connection for this object.

SIP2Class in namespace VuFind\Auth

SIP2 authentication module.

ShibbolethClass in namespace VuFind\Auth

Shibboleth authentication module.

$ Shibboleth#sessionManagerProperty in class Shibboleth

Session manager

$ Shibboleth#shibIdentityProviderProperty in class Shibboleth

Name of attribute with shibboleth identity provider

$ Shibboleth#shibSessionIdProperty in class Shibboleth

Name of attribute with shibboleth session ID

Shibboleth::setConfig() — Method in class Shibboleth

Set configuration.

Shibboleth::storeShibbolethSession() — Method in class Shibboleth

Add session id mapping to external_session table for single logout support

ShibbolethFactoryClass in namespace VuFind\Auth

Factory for Shibboleth authentication module.

$ MultiIdPConfigurationLoader#shibConfigProperty in class MultiIdPConfigurationLoader

Configured IdPs with entityId and overridden attribute mapping

SingleIdPConfigurationLoaderClass in namespace VuFind\Auth\Shibboleth

Configuration loader for single IdP

AutocompleteInterface::setConfig() — Method in class AutocompleteInterface

Set parameters that affect the behavior of the autocomplete handler.

$ Eds#searchClassIdProperty in class Eds

Search object family to use

$ Eds#searchServiceProperty in class Eds

Search service

Eds::setConfig() — Method in class Eds

Set parameters that affect the behavior of the autocomplete handler.

None::setConfig() — Method in class None

Set parameters that affect the behavior of the autocomplete handler.

OCLCIdentities::setConfig() — Method in class OCLCIdentities

Set parameters that affect the behavior of the autocomplete handler.

Search2Class in namespace VuFind\Autocomplete

Search2 Autocomplete Module

$ Search2#searchClassIdProperty in class Search2

Search object family to use

Search2CNClass in namespace VuFind\Autocomplete

Search2 Call Number Autocomplete Module

$ Search2CN#searchClassIdProperty in class Search2CN

Search object family to use

SolrClass in namespace VuFind\Autocomplete

Solr Autocomplete Module

$ Solr#sortFieldProperty in class Solr

Solr field to use for sorting

$ Solr#searchClassIdProperty in class Solr

Search object family to use

$ Solr#searchObjectProperty in class Solr

Search results object

Solr::setConfig() — Method in class Solr

Set parameters that affect the behavior of the autocomplete handler.

Solr::setDisplayField() — Method in class Solr

Set the display field list. Useful for child classes.

Solr::setSortField() — Method in class Solr

Set the sort field list. Useful for child classes.

SolrAuthClass in namespace VuFind\Autocomplete

Solr Authority Autocomplete Module

SolrCNClass in namespace VuFind\Autocomplete

Solr Call Number Autocomplete Module

SolrCN::setConfig() — Method in class SolrCN

Set parameters that affect the behavior of the autocomplete handler.

SolrFactoryClass in namespace VuFind\Autocomplete

Factory for Solr-driven autocomplete plugins. Works for \VuFind\Autocomplete\Solr and all of its subclasses.

SolrPrefixClass in namespace VuFind\Autocomplete

Solr autocomplete module with prefix queries using edge N-gram filter

$ SolrPrefix#searchObjectProperty in class SolrPrefix

Search object

$ SolrPrefix#searchClassIdProperty in class SolrPrefix

Search class id

SolrPrefix::setConfig() — Method in class SolrPrefix

Set configuration

SolrReservesClass in namespace VuFind\Autocomplete

Solr Reserves Autocomplete Module

SuggesterClass in namespace VuFind\Autocomplete

Autocomplete handler plugin manager

SuggesterFactoryClass in namespace VuFind\Autocomplete

Factory for autocomplete suggester.

Tag::setConfig() — Method in class Tag

Set parameters that affect the behavior of the autocomplete handler.

ScopusClass in namespace VuFind\CSV\ImportHelper

Helpers for Scopus CSV import example.

Scopus::splitNames() — Method in class Scopus

Given a string of multiple last name/initial pairs, split it into an array of name strings.

$ Importer#serviceLocatorProperty in class Importer

Service locator

Importer::save() — Method in class Importer

Save a CSV file to the Solr index using the specified configuration.

CacheTrait::setCacheStorage() — Method in class CacheTrait

Set a cache storage object.

$ Interval#sessionDataProperty in class Interval

Session data container

$ Cart#showTogglesInSearchProperty in class Cart

Is cart configured to toggles in search results?

Cart::save() — Method in class Cart

Save the state of the cart. This implementation uses cookie so the cart contents can be manipulated on the client side as well.

AbstractChannelProvider::setCoverRouter() — Method in class AbstractChannelProvider

Inject cover router

AbstractChannelProvider::setRecordRouter() — Method in class AbstractChannelProvider

Inject record router

AbstractChannelProvider::setProviderId() — Method in class AbstractChannelProvider

Set an identifier that will be injected as the 'providerId' key of all channels created by this provider.

AbstractChannelProvider::setOptions() — Method in class AbstractChannelProvider

Set the options for the provider.

AbstractChannelProvider::summarizeRecordDrivers() — Method in class AbstractChannelProvider

Convert a search results object into channel contents.

$ AbstractILSChannelProvider#searchServiceProperty in class AbstractILSChannelProvider

Search service

AbstractILSChannelProvider::setOptions() — Method in class AbstractILSChannelProvider

Set the options for the provider.

$ AlphaBrowse#searchServiceProperty in class AlphaBrowse

Search service

$ AlphaBrowse#solrFieldProperty in class AlphaBrowse

Solr field to use for search seed

$ AlphaBrowse#sourceProperty in class AlphaBrowse

The search backend to query

AlphaBrowse::setOptions() — Method in class AlphaBrowse

Set the options for the provider.

AlphaBrowse::summarizeBrowseDetails() — Method in class AlphaBrowse

Given details from alphabeticBrowse(), create channel contents.

$ ChannelLoader#searchRunnerProperty in class ChannelLoader

Search runner

ChannelProviderInterface::setOptions() — Method in class ChannelProviderInterface

Set the options for the provider.

ChannelProviderInterface::setProviderId() — Method in class ChannelProviderInterface

Set an identifier that will be injected as the 'providerId' key of all channels created by this provider.

Facets::setOptions() — Method in class Facets

Set the options for the provider.

ListItems::setOptions() — Method in class ListItems

Set the options for the provider.

$ Random#searchServiceProperty in class Random

Search service

Random::setOptions() — Method in class Random

Set the options for the provider.

SimilarItemsClass in namespace VuFind\ChannelProvider

"Similar items" channel provider.

$ SimilarItems#searchServiceProperty in class SimilarItems

Search service

SimilarItems::setOptions() — Method in class SimilarItems

Set the options for the provider.

SimilarItemsFactoryClass in namespace VuFind\ChannelProvider

Factory for SimilarItems channel provider.

TrendingILSItems::setOptions() — Method in class TrendingILSItems

Set the options for the provider.

$ CacheDecorator#storageProperty in class CacheDecorator

Cache storage.

SearchSpecsReaderClass in namespace VuFind\Config

VuFind SearchSpecs Configuration Reader

Upgrade::saveModifiedConfig() — Method in class Upgrade

Save a modified configuration file.

Upgrade::saveUnmodifiedConfig() — Method in class Upgrade

Save an unmodified configuration file -- copy the old version, unless it is the same as the new version!

Writer::set() — Method in class Writer

Change/add a setting

Writer::save() — Method in class Writer

Save the modified file to disk. Return true on success, false on error.

Oracle::simpleSelect() — Method in class Oracle

Execute a SQL statement and return the results.

Oracle::simpleDelete() — Method in class Oracle

Delete row(s) from a table.

Oracle::simpleInsert() — Method in class Oracle

Insert a row into a table.

Oracle::simpleSql() — Method in class Oracle

Execute a simple SQL statement.

Relais::search() — Method in class Relais

Perform a search

Wikipedia::setLanguage() — Method in class Wikipedia

Set language

Wikipedia::stripImageAndFileLinks() — Method in class Wikipedia

Support method for sanitizeWikipediaBody -- strip image/file links.

Wikipedia::sanitizeWikipediaBody() — Method in class Wikipedia

Support method for parseWikipedia - fix up details in the body

$ WorldCatUtils#silentProperty in class WorldCatUtils

Should we silently ignore HTTP failures?

AbstractBase::setConfig() — Method in class AbstractBase

Store the configuration of the content block.

$ Channels#sourceProperty in class Channels

Data source (null to use default found in channels.ini)

Channels::setConfig() — Method in class Channels

Store the configuration of the content block.

ContentBlockInterface::setConfig() — Method in class ContentBlockInterface

Store the configuration of the content block.

$ FacetList#searchClassIdProperty in class FacetList

Search class ID to use for retrieving facets.

FacetList::setConfig() — Method in class FacetList

Store the configuration of the content block.

IlsStatusMonitor::setConfig() — Method in class IlsStatusMonitor

Store the configuration of the content block.

TemplateBased::setConfig() — Method in class TemplateBased

Store the configuration of the content block.

$ AbstractCover#supportsIsbnProperty in class AbstractCover

Does this plugin support ISBNs?

$ AbstractCover#supportsIssnProperty in class AbstractCover

Does this plugin support ISSNs?

$ AbstractCover#supportsIsmnProperty in class AbstractCover

Does this plugin support ISMNs?

$ AbstractCover#supportsOclcProperty in class AbstractCover

Does this plugin support OCLC numbers?

$ AbstractCover#supportsUpcProperty in class AbstractCover

Does this plugin support UPC numbers?

$ AbstractCover#supportsNbnProperty in class AbstractCover

Does this plugin support national bibliographies number?

$ AbstractCover#supportsRecordidProperty in class AbstractCover

Does this plugin support getting cover by local id?

$ AbstractCover#supportsUuidProperty in class AbstractCover

Does this plugin support getting cover by UUID (Universally unique identifier)?

AbstractCover::supports() — Method in class AbstractCover

Does this plugin support the provided ID array?

SyndeticsClass in namespace VuFind\Content\AuthorNotes

Syndetics author notes content loader.

$ Syndetics#sourceListProperty in class Syndetics

List of data sources for author notes.

$ BrowZine#searchServiceProperty in class BrowZine

Search service

Deprecated::supports() — Method in class Deprecated

Does this plugin support the provided ID array?

LocalFile::supports() — Method in class LocalFile

Does this plugin support the provided ID array?

$ ObalkyKnih#serviceProperty in class ObalkyKnih

Obalky knih service

SummonClass in namespace VuFind\Content\Covers

Summon cover content loader.

SyndeticsClass in namespace VuFind\Content\Covers

Syndetics cover content loader.

SyndeticsFactoryClass in namespace VuFind\Content\Covers

Syndetics cover loader factory

SyndeticsClass in namespace VuFind\Content\Excerpts

Syndetics excerpt content loader.

$ Syndetics#sourceListProperty in class Syndetics

List of syndetic excerpts

$ ObalkyKnihService#siglaProperty in class ObalkyKnihService

Sigla - library identifier

SyndeticsClass in namespace VuFind\Content\Reviews

Syndetics review content loader.

$ Syndetics#sourceListProperty in class Syndetics

List of syndetic review sources

SyndeticsClass in namespace VuFind\Content\Summaries

Syndetics Summaries content loader.

$ Syndetics#sourceListProperty in class Syndetics

List of data sources for author notes.

SyndeticsClass in namespace VuFind\Content\TOC

Syndetics TOC content loader.

$ Syndetics#sourceListProperty in class Syndetics

List of data sources for author notes.

$ AbstractBase#serviceLocatorProperty in class AbstractBase

Service manager

AbstractBase::setAccessPermission() — Method in class AbstractBase

Getter for access permission.

AbstractBase::setFollowupUrlToReferer() — Method in class AbstractBase

Store a referer (if appropriate) to keep post-login redirect pointing to an appropriate location. This is used when the user clicks the log in link from an arbitrary page or when a password is mistyped; separate logic is used for storing followup information when VuFind forces the user to log in from another context.

AbstractBase::storageRetrievalRequests() — Method in class AbstractBase

StorageRetrievalRequests plugin

$ AbstractRecord#sourceIdProperty in class AbstractRecord

Type of record to display

AbstractRecord::saveAction() — Method in class AbstractRecord

Save action - Allows the save template to appear, passes containingLists & nonContainingLists

AbstractRecord::smsEnabled() — Method in class AbstractRecord

Is SMS enabled?

AbstractRecord::smsAction() — Method in class AbstractRecord

SMS action - Allows the SMS form to appear.

AbstractRecord::showTab() — Method in class AbstractRecord

Display a particular tab.

$ AbstractSearch#searchClassIdProperty in class AbstractSearch

Search class family to use.

$ AbstractSearch#saveToHistoryProperty in class AbstractSearch

Should we save searches to history?

AbstractSearch::saveSearchToHistory() — Method in class AbstractSearch

Save a search to the history in the database.

AjaxController::systemStatusAction() — Method in class AjaxController

Check status and return a status message for e.g. a load balancer.

AjaxResponseTrait::storeError() — Method in class AjaxResponseTrait

Store the errors for later, to be added to the output

AlmaController::sendSetPasswordEmail() — Method in class AlmaController

Send the "set password email" to a new user that was created in Alma and sent to VuFind via webhook.

AuthorController::searchAction() — Method in class AuthorController

Sets the configuration for performing an author search

AuthorityController::searchAction() — Method in class AuthorityController

Search action -- call standard results action

BrowZineController::searchAction() — Method in class BrowZineController

Search action -- call standard results action

BrowseController::setCurrentAction() — Method in class BrowseController

Set the name of the current action.

$ CartController#sessionProperty in class CartController

Session container

CartController::searchresultsbulkAction() — Method in class CartController

Process requests for bulk actions from search results.

CartController::saveAction() — Method in class CartController

Save a batch of records.

ChannelsController::searchAction() — Method in class ChannelsController

Generates channels for a search.

CollectionController::showTab() — Method in class CollectionController

Display a particular tab.

CollectionsController::showBrowseAlphabetic() — Method in class CollectionsController

Show the Browse Menu

CollectionsController::showBrowseIndex() — Method in class CollectionsController

Show the Browse Menu

CollectionsController::sortFindKeyLocation() — Method in class CollectionsController

Function to sort the results and find the position of the from value in the result set; if the value doesn't exist, it's inserted.

CombinedController::searchboxAction() — Method in class CombinedController

Action to process the combined search box.

$ CoverController#sessionSettingsProperty in class CoverController

Session settings

CoverController::showAction() — Method in class CoverController

Send image data for display in the view

EITController::searchAction() — Method in class EITController

Search action -- call standard results action

EdsController::searchAction() — Method in class EdsController

Search action -- call standard results action

HierarchyController::searchtreeAction() — Method in class HierarchyController

Search the tree and echo a json result of items that matched the keywords.

InstallController::showsqlAction() — Method in class InstallController

Display captured SQL commands for database action.

LibraryCardsController::selectCardAction() — Method in class LibraryCardsController

Activates a library card

MyResearchController::storeRefererForPostLoginRedirect() — Method in class MyResearchController

Maintaining this method for backwards compatibility; logic moved to parent and method re-named

MyResearchController::setSavedFlagSecurely() — Method in class MyResearchController

Support method for savesearchAction(): set the saved flag in a secure fashion, throwing an exception if somebody attempts something invalid.

MyResearchController::scheduleSearch() — Method in class MyResearchController

Support method for savesearchAction() -- schedule a search.

MyResearchController::schedulesearchAction() — Method in class MyResearchController

Handle search subscription request

MyResearchController::savesearchAction() — Method in class MyResearchController

Handle 'save/unsave search' request

MyResearchController::storageRetrievalRequestsAction() — Method in class MyResearchController

Send list of storage retrieval requests to view

MyResearchController::sendRecoveryEmail() — Method in class MyResearchController

Helper function for recoverAction

MyResearchController::sendFirstVerificationEmail() — Method in class MyResearchController

Send a verify email message for the first time (only if the user does not already have a hash).

MyResearchController::sendChangeNotificationEmail() — Method in class MyResearchController

When a request to change a user's email address has been received, we should send a notification to the old email address for the user's information.

MyResearchController::sendVerificationEmail() — Method in class MyResearchController

Send a verify email message.

MyResearchController::setUpAuthenticationFromRequest() — Method in class MyResearchController

Configure the authentication manager to use a user-specified method.

$ OAuth2Controller#sessionProperty in class OAuth2Controller

Session container

OaiController::serverAction() — Method in class OaiController

Standard OAI server.

Pazpar2Controller::searchAction() — Method in class Pazpar2Controller

Search action -- call standard results action

$ AbstractRequestBase#sessionProperty in class AbstractRequestBase

Session data

$ AbstractRequestBase#sessionManagerProperty in class AbstractRequestBase

Session manager

Captcha::setErrorMode() — Method in class Captcha

Flash messages ('flash') or throw exceptions ('throw')

DbUpgrade::setAdapter() — Method in class DbUpgrade

Set a database adapter.

Favorites::saveBulk() — Method in class Favorites

Save a group of records to the user's favorites.

$ Followup#sessionProperty in class Followup

Session container

Followup::store() — Method in class Followup

Store the current URL (and optional additional information) in the session for use following a successful login.

$ Reserves#searchServiceProperty in class Reserves

Search service

ResultScroller::scrollOnCurrentPage() — Method in class ResultScroller

Return a modified results array to help scroll the user through the current page of results

ResultScroller::scrollToPreviousPage() — Method in class ResultScroller

Return a modified results array for the case where we need to retrieve data from the previous page of results

ResultScroller::scrollToNextPage() — Method in class ResultScroller

Return a modified results array for the case where we need to retrieve data from the next page of results

ResultScroller::scrollToFirstRecord() — Method in class ResultScroller

Return a modified results array for the case where we need to retrieve data from the the first page of results

ResultScroller::scrollToLastRecord() — Method in class ResultScroller

Return a modified results array for the case where we need to retrieve data from the the last page of results

StorageRetrievalRequestsClass in namespace VuFind\Controller\Plugin

Action helper to perform storage retrieval request related actions

PrimoController::searchAction() — Method in class PrimoController

Search action -- call standard results action

$ QRCodeController#sessionSettingsProperty in class QRCodeController

Session settings

QRCodeController::showAction() — Method in class QRCodeController

Send QRCode data for display in the view

Search2ControllerClass in namespace VuFind\Controller

Search2 Controller

Search2collectionControllerClass in namespace VuFind\Controller

Collection Controller

$ Search2collectionController#searchClassIdProperty in class Search2collectionController
Search2recordControllerClass in namespace VuFind\Controller

Search2 Record Controller

SearchControllerClass in namespace VuFind\Controller

Redirects the user to the appropriate default VuFind action.

SearchController::suggestAction() — Method in class SearchController

Provide OpenSearch suggestions as specified at http://www.opensearch.org/Specifications/OpenSearch/Extensions/Suggestions/1.0

ShibbolethLogoutNotificationControllerClass in namespace VuFind\Controller

Handles Shibboleth back-channel logout notifications.

ShortlinkControllerClass in namespace VuFind\Controller

Short link controller

StorageRetrievalRequestsTraitClass in namespace VuFind\Controller

Storage retrieval requests trait (for subclasses of AbstractRecord)

StorageRetrievalRequestsTrait::storageRetrievalRequestAction() — Method in class StorageRetrievalRequestsTrait

Action for dealing with storage retrieval requests.

SummonControllerClass in namespace VuFind\Controller

Summon Controller

SummonController::searchAction() — Method in class SummonController

Search action -- call standard results action

SummonrecordControllerClass in namespace VuFind\Controller

Summon Record Controller

$ UpgradeController#sessionProperty in class UpgradeController

Session container

UpgradeController::setDbEncodingConfiguration() — Method in class UpgradeController

Configure the database encoding.

UpgradeController::showsqlAction() — Method in class UpgradeController

Prompt the user for database credentials.

WorldcatController::searchAction() — Method in class WorldcatController

Search action -- call standard results action

$ CookieManager#secureProperty in class CookieManager

Are cookies secure only?

$ CookieManager#sessionNameProperty in class CookieManager

The name of the session cookie

$ CookieManager#sameSiteProperty in class CookieManager

Default SameSite attribute

CookieManager::setGlobalCookie() — Method in class CookieManager

Support method for set() -- set the actual cookie in PHP.

CookieManager::set() — Method in class CookieManager

Set a cookie.

CachingProxy::setCache() — Method in class CachingProxy

Save a response to the cache.

$ Generator#settingsProperty in class Generator

Active style configuration

Generator::setOptions() — Method in class Generator

Set the generator options.

SolidBackgroundClass in namespace VuFind\Cover\Layer

Solid cover background layer

$ Loader#sourceProperty in class Loader

User record source parameter

$ Loader#sizeProperty in class Loader

User size parameter

Loader::setCoverGenerator() — Method in class Loader

Set Cover Generator Object

Loader::storeSanitizedSettings() — Method in class Loader

Support method for loadImage() -- sanitize and store some key values.

OaiResumption::saveParams() — Method in class OaiResumption

Encode an array of parameters into the object.

$ PrivateUser#sessionProperty in class PrivateUser

Session container for account information.

PrivateUser::save() — Method in class PrivateUser
Save
PrivateUser::setSession() — Method in class PrivateUser

Set session container

$ Resource#sourceProperty in class Resource
SearchClass in namespace VuFind\Db\Row

Row Definition for search

$ Search#session_idProperty in class Search
$ Search#savedProperty in class Search
$ Search#search_objectProperty in class Search
Search::save() — Method in class Search
Save
Search::setLastExecuted() — Method in class Search

Set last executed time for scheduled alert.

Search::setSchedule() — Method in class Search

Set schedule for scheduled alert.

SessionClass in namespace VuFind\Db\Row

Row Definition for session

ShortlinksClass in namespace VuFind\Db\Row

Row Definition for shortlinks

User::setConfig() — Method in class User

Configuration setter

User::saveCatalogId() — Method in class User

Save ILS ID.

User::saveCredentials() — Method in class User

Save ILS login credentials.

User::saveEmailVerified() — Method in class User

Save date/time when email address has been verified.

User::saveResource() — Method in class User

Add/update a resource in the user's account.

User::saveLibraryCard() — Method in class User

Save library card with the given information

$ UserCard#savedProperty in class UserCard
$ UserList#sessionProperty in class UserList

Session container for last list information.

UserList::save() — Method in class UserList

Saves the properties to the database.

UserList::setSession() — Method in class UserList

Set session container

AccessToken::storeNonce() — Method in class AccessToken

Add or replace an OpenID nonce for a user

ChangeTracker::strToUtcTime() — Method in class ChangeTracker

Convert a string to time in UTC.

DbTableAwareInterface::setDbTableManager() — Method in class DbTableAwareInterface

Set the plugin manager.

DbTableAwareTrait::setDbTableManager() — Method in class DbTableAwareTrait

Set the table plugin manager.

OaiResumption::saveToken() — Method in class OaiResumption

Create a new resumption token

SearchClass in namespace VuFind\Db\Table

Table Definition for search

Search::saveSearch() — Method in class Search

Add a search into the search table (history)

SessionClass in namespace VuFind\Db\Table

Table Definition for session

ShortlinksClass in namespace VuFind\Db\Table

Table Definition for shortlinks

$ User#sessionProperty in class User

Session container

$ UserList#sessionProperty in class UserList

Session container for last list information.

$ OverdriveConnector#sessionContainerProperty in class OverdriveConnector

Session Container

OverdriveConnector::setCacheStorage() — Method in class OverdriveConnector

Set a cache storage object.

$ BrowZine#searchServiceProperty in class BrowZine

Search service

$ HttpDownloadException#statusCodeProperty in class HttpDownloadException

HTTP status associated with this exception.

SessionExpiredClass in namespace VuFind\Exception

Session Expired Exception

SeverityLevelInterfaceClass in namespace VuFind\Exception

Interface for exceptions to indicate the logging severity level.

FavoritesService::save() — Method in class FavoritesService

Save this record to the user's favorites.

Entry::setDCDate() — Method in class Entry

Set the Dublin Core date.

Entry::setDCFormats() — Method in class Entry

Set entry format elements

Entry::setDCDate() — Method in class Entry

Set entry date elements

$ Feed#startIndexProperty in class Feed

Start index

$ Feed#searchTermsProperty in class Feed

Search terms

$ Feed#stringWrapperProperty in class Feed

The used string wrapper supporting encoding

Feed::setEncoding() — Method in class Feed

Set feed encoding

Feed::setOpensearchTotalResults() — Method in class Feed

Set total results

Feed::setOpensearchStartIndex() — Method in class Feed

Set start index

Feed::setOpensearchItemsPerPage() — Method in class Feed

Set items per page

Feed::setOpensearchSearchTerms() — Method in class Feed

Set search terms

Feed::setTotalResults() — Method in class Feed

Set total results

Feed::setStartIndex() — Method in class Feed

Set start index

Feed::setItemsPerPage() — Method in class Feed

Set items per page

Feed::setQuery() — Method in class Feed

Set the query element

Feed::setLinks() — Method in class Feed

Set links

Form::setFormId() — Method in class Form

Set form id

Form::showOnlyForLoggedUsers() — Method in class Form

Check if form is available only for logged users.

Email::sendEmail() — Method in class Email

Send form data as email.

AbstractBase::showTree() — Method in class AbstractBase

Find out whether or not to show the tree

ConfigurationBased::showTree() — Method in class ConfigurationBased

Show Tree

$ AbstractBase#sortProperty in class AbstractBase

Is sorting enabled?

AbstractBase::setRawData() — Method in class AbstractBase

Set raw data.

AbstractBase::sortNodes() — Method in class AbstractBase

Sort Nodes Convert an unsorted array of [ key, value ] pairs into a sorted array of values.

AbstractBase::setHierarchyDriver() — Method in class AbstractBase

Set the hierarchy driver

AbstractBase::supports() — Method in class AbstractBase

Does this data source support the specified hierarchy ID?

Search2Class in namespace VuFind\Hierarchy\TreeDataSource

Hierarchy Tree Data Source (Search2)

Search2FactoryClass in namespace VuFind\Hierarchy\TreeDataSource

Search2 Hierarchy tree data source plugin factory.

SolrClass in namespace VuFind\Hierarchy\TreeDataSource

Hierarchy Tree Data Source (Solr)

$ Solr#searchServiceProperty in class Solr

Search service

Solr::searchSolrLegacy() — Method in class Solr

Search Solr using legacy, non-cursorMark method (sometimes needed for backward compatibility, but usually disabled).

Solr::searchSolrCursor() — Method in class Solr

Search Solr using a cursor.

Solr::searchSolr() — Method in class Solr

Search Solr.

Solr::supports() — Method in class Solr

Does this data source support the specified hierarchy ID?

SolrFactoryClass in namespace VuFind\Hierarchy\TreeDataSource

Solr Hierarchy tree data source plugin factory.

XMLFile::supports() — Method in class XMLFile

Does this data source support the specified hierarchy ID?

AbstractBase::setRecordDriver() — Method in class AbstractBase

Set the record driver to operate on

CachingDownloader::setUpCache() — Method in class CachingDownloader

Set up a different cache.

CachingDownloaderAwareInterface::setCachingDownloader() — Method in class CachingDownloaderAwareInterface

Set a caching downloader.

CachingDownloaderAwareTrait::setCachingDownloader() — Method in class CachingDownloaderAwareTrait

Set caching downloader

HasSorterInterface::setSorter() — Method in class HasSorterInterface

Set the sorter

$ HasSorterTrait#sorterProperty in class HasSorterTrait
Sorter
HasSorterTrait::setSorter() — Method in class HasSorterTrait

Set the sorter

SorterClass in namespace VuFind\I18n

Class Sorter

Sorter::sort() — Method in class Sorter

Sort array by values

SorterFactoryClass in namespace VuFind\I18n

Class SorterFactory

SorterInterfaceClass in namespace VuFind\I18n

Interface SorterInterface

SorterInterface::sort() — Method in class SorterInterface

Sort array by values

$ TranslatableString#stringProperty in class TranslatableString

Original string

TranslatorAwareInterface::setTranslator() — Method in class TranslatorAwareInterface

Set a translator

TranslatorAwareTrait::setTranslator() — Method in class TranslatorAwareTrait

Set a translator

Connection::setHoldConfig() — Method in class Connection

Set the hold configuration for the connection.

Connection::setDriver() — Method in class Connection

Set a driver object.

AbstractAPI::setConfig() — Method in class AbstractAPI

Set the configuration for the driver.

AbstractBase::setConfig() — Method in class AbstractBase

Set configuration.

$ Aleph#sublibadmProperty in class Aleph

List of patron hoe libraries

Aleph::supportsMethod() — Method in class Aleph

Helper method to determine whether or not a certain method can be called on this driver. Required method for any smart drivers.

AlephRestfulException::setXmlResponse() — Method in class AlephRestfulException

Attach an XML response to the exception

Alma::supportsMethod() — Method in class Alma

Helper method to determine whether or not a certain method can be called on this driver. Required method for any smart drivers.

$ Amicus#statusRankingsProperty in class Amicus

Stored status rankings from the database; initialized to false but populated by the pickStatus() method.

Amicus::sacaStatus() — Method in class Amicus

Function that returns the number or on loan items for a given copy number.

Amicus::sacaFecha() — Method in class Amicus

Function that returns the due date or a special message.

Amicus::sacaReservas() — Method in class Amicus

Function that returns the numbers of holds for a copy id number given.

$ Demo#searchServiceProperty in class Demo

Connection used when getting random bib ids from Solr

$ Demo#sessionProperty in class Demo

Container for storing persistent simulated ILS data.

$ Demo#sessionFactoryProperty in class Demo

Factory function for constructing the SessionContainer.

$ Demo#storageRetrievalRequestsProperty in class Demo

Should we support Storage Retrieval Requests?

Demo::setStatus() — Method in class Demo

Set Status

DriverInterface::setConfig() — Method in class DriverInterface

Set configuration.

$ Folio#sessionFactoryProperty in class Folio

Factory function for constructing the SessionContainer.

$ Folio#sessionCacheProperty in class Folio

Session cache

Folio::setConfig() — Method in class Folio

Set the configuration for the driver.

$ GeniePlus#sessionFactoryProperty in class GeniePlus

Factory function for constructing the SessionContainer.

$ GeniePlus#sessionCacheProperty in class GeniePlus

Session cache

GeniePlus::sanitizeQueryParam() — Method in class GeniePlus

Sanitize a value for inclusion as a single-quoted value in a query string.

Innovative::sendRequest() — Method in class Innovative

Make an HTTP request

$ Koha#showBlockCommentsProperty in class Koha

Display comments for patron debarments, see Koha.ini

$ KohaILSDI#showBlockCommentsProperty in class KohaILSDI

Display comments for patron debarments, see KohaILSDI.ini

$ KohaILSDI#showPermanentLocationProperty in class KohaILSDI

Should we show permanent location (or current)

$ KohaILSDI#showHomebranchProperty in class KohaILSDI

Should we show homebranchinstead of holdingbranch

KohaILSDI::supportsMethod() — Method in class KohaILSDI

Helper method to determine whether or not a certain method can be called on this driver. Required method for any smart drivers.

$ KohaRest#sourceProperty in class KohaRest

Library prefix

$ KohaRest#sessionFactoryProperty in class KohaRest

Factory function for constructing the SessionContainer.

$ KohaRest#sessionCacheProperty in class KohaRest

Session cache

$ KohaRest#statusRankingsProperty in class KohaRest

Item status rankings. The lower the value, the more important the status.

$ KohaRest#sortItemsBySerialIssueProperty in class KohaRest

Whether to sort items by serial issue. Default is true.

KohaRest::supportsMethod() — Method in class KohaRest

Helper method to determine whether or not a certain method can be called on this driver. Required method for any smart drivers.

KohaRest::statusSortFunction() — Method in class KohaRest

Status item sort function

$ MultiBackend#sourceCheckFieldsProperty in class MultiBackend

An array of methods that should determine source from a specific parameter field

MultiBackend::setConfig() — Method in class MultiBackend

Set the driver configuration.

MultiBackend::supportsMethod() — Method in class MultiBackend

Helper method to determine whether or not a certain method can be called on this driver. Required method for any smart drivers.

MultiBackend::stripIdPrefixes() — Method in class MultiBackend

Change global ID's to local ID's in the given array

$ PAIA#sessionProperty in class PAIA

Session containing PAIA login information

$ PAIA#sessionManagerProperty in class PAIA
SessionManager
$ PAIA#statusStringsProperty in class PAIA

PAIA status strings

Polaris::suspendHolds() — Method in class Polaris

Suspend Holds

SampleClass in namespace VuFind\ILS\Driver

Lightweight Dummy ILS Driver -- Always returns hard-coded sample values.

SierraClass in namespace VuFind\ILS\Driver

Sierra (III) ILS Driver for VuFind

SierraRestClass in namespace VuFind\ILS\Driver

III Sierra REST API driver

$ SierraRest#sessionFactoryProperty in class SierraRest

Factory function for constructing the SessionContainer.

$ SierraRest#sessionCacheProperty in class SierraRest

Session cache

$ SierraRest#sortItemsByEnumChronProperty in class SierraRest

Whether to sort items by enumchron. Default is true.

SierraRest::setConfig() — Method in class SierraRest

Set configuration.

SierraRest::supportsMethod() — Method in class SierraRest

Helper method to determine whether or not a certain method can be called on this driver. Required method for any smart drivers.

SierraRest::statusSortFunction() — Method in class SierraRest

Status item sort function

SierraRestFactoryClass in namespace VuFind\ILS\Driver

Factory for SierraRest ILS driver.

SymphonyClass in namespace VuFind\ILS\Driver

Symphony Web Services (symws) ILS Driver

SymphonyFactoryClass in namespace VuFind\ILS\Driver

Factory for Symphony ILS driver.

$ Unicorn#search_progProperty in class Unicorn

Name of API program

$ Voyager#statusRankingsProperty in class Voyager

Stored status rankings from the database; initialized to false but populated by the pickStatus() method.

Voyager::sanitizePIN() — Method in class Voyager

Sanitize patron PIN code (remove characters Voyager doesn't handle properly)

VoyagerRestful::supportsMethod() — Method in class VoyagerRestful

Helper method to determine whether or not a certain method can be called on this driver. Required method for any smart drivers.

$ XCNCIP2#storageRetrievalRequestTypesProperty in class XCNCIP2

Lowercased request type strings identifying storage retrievals

$ XCNCIP2#schemesProperty in class XCNCIP2

Schemes preset for certain elements. See implementation profile: http://www.ncip.info/uploads/7/1/4/6/7146749/z39-83-2-2012_ncip.pdf

XCNCIP2::sendRequest() — Method in class XCNCIP2

Send an NCIP request.

Holds::standardHoldings() — Method in class Holds

Protected method for standard (i.e. No Holds) holdings

ImageLoader::setThemeInfo() — Method in class ImageLoader

Setter for dependency

ImageLoader::searchTheme() — Method in class ImageLoader

Find a file in the themes (return false if no file exists).

Post::setContentType() — Method in class Post

Set verbosity

SlackClass in namespace VuFind\Log\Writer

This class extends the Laminas Logging to send errors to Slack

StreamClass in namespace VuFind\Log\Writer

This class extends the Laminas Logging towards streams

VerbosityTrait::setVerbosity() — Method in class VerbosityTrait

Set verbosity

Mailer::setTransport() — Method in class Mailer

Set the mail transport object.

Mailer::stringToAddressList() — Method in class Mailer

Convert a delimited string to an address list.

Mailer::send() — Method in class Mailer

Send an email message.

Mailer::sendLink() — Method in class Mailer

Send an email message representing a link.

Mailer::sendRecord() — Method in class Mailer

Send an email message representing a record.

Mailer::setMaxRecipients() — Method in class Mailer

Set the maximum number of email recipients

Mailer::setFromAddressOverride() — Method in class Mailer

Set the "From" address override

$ UserIpReader#serverProperty in class UserIpReader

Server parameters

DefaultSpellingNormalizer::stripDiacritics() — Method in class DefaultSpellingNormalizer

Remove diacritics (accents, umlauts, etc.) from a string

ServerClass in namespace VuFind\OAI

OAI Server class

$ Server#searchClassIdProperty in class Server

Search object class to use

$ Server#setFieldProperty in class Server

Solr field for set membership

$ Server#setQueriesProperty in class Server

Set queries

Server::setRecordLinkerHelper() — Method in class Server

Add a record linker helper (optional -- allows enhancement of some metadata with VuFind-specific links).

Server::setRecordFormatter() — Method in class Server

Add a record formatter (optional -- allows the vufind record format to be returned).

Server::supportsVuFindMetadata() — Method in class Server

Does the current configuration support the VuFind metadata format (using the API's record formatter.

Server::saveResumptionToken() — Method in class Server

Generate a resumption token to continue the current operation.

Server::showError() — Method in class Server

Display an error response.

Server::stripID() — Method in class Server

Strip the OAI prefix from the provided ID number.

ServerFactoryClass in namespace VuFind\OAI

OAI Server factory.

ClientEntity::setName() — Method in class ClientEntity

Set the client's name.

ScopeEntityClass in namespace VuFind\OAuth2\Entity

OAuth2 scope entity implementation.

ScopeEntity::setDescription() — Method in class ScopeEntity

Set description

ScopeEntity::setHidden() — Method in class ScopeEntity

Set hidden flag

ScopeEntity::setILSNeeded() — Method in class ScopeEntity

Set ILS needed flag

ScopeRepositoryClass in namespace VuFind\OAuth2\Repository

OAuth2 scope repository implementation.

AbstractResultsPassthrough::setConfig() — Method in class AbstractResultsPassthrough

Store the configuration of the recommendation module.

AbstractSummonRecommend::setConfig() — Method in class AbstractSummonRecommend

Store the configuration of the recommendation module.

AbstractSummonRecommendDeferred::setConfig() — Method in class AbstractSummonRecommendDeferred

Store the configuration of the recommendation module.

AlphaBrowseLink::setConfig() — Method in class AlphaBrowseLink

Store the configuration of the recommendation module.

$ AuthorFacets#settingsProperty in class AuthorFacets

Configuration settings

AuthorFacets::setConfig() — Method in class AuthorFacets

Store the configuration of the recommendation module.

$ AuthorInfo#searchObjectProperty in class AuthorInfo

Saved search results

$ AuthorInfo#sourcesProperty in class AuthorInfo

Sources of author data that may be used (comma-delimited string; currently only 'wikipedia' is supported).

AuthorInfo::setConfig() — Method in class AuthorInfo

Store the configuration of the recommendation module.

AuthorInfo::setTranslator() — Method in class AuthorInfo

Set a translator

AuthorityRecommend::setConfig() — Method in class AuthorityRecommend

Store the configuration of the recommendation module.

CollectionSideFacets::setConfig() — Method in class CollectionSideFacets

Store the configuration of the recommendation module.

DOI::setConfig() — Method in class DOI

Store the configuration of the recommendation module.

$ DPLATerms#searchObjectProperty in class DPLATerms

Search results object

DPLATerms::setConfig() — Method in class DPLATerms

Store the configuration of the recommendation module.

Deprecated::setConfig() — Method in class Deprecated

Store the configuration of the recommendation module.

EDSResultsDeferred::setConfig() — Method in class EDSResultsDeferred

Store the configuration of the recommendation module.

$ EuropeanaResults#searchSiteProperty in class EuropeanaResults

Site to search

$ EuropeanaResults#sitePathProperty in class EuropeanaResults

Link for more results

EuropeanaResults::setConfig() — Method in class EuropeanaResults

Store the configuration of the recommendation module.

EuropeanaResultsDeferred::setConfig() — Method in class EuropeanaResultsDeferred

Store the configuration of the recommendation module.

$ ExpandFacets#settingsProperty in class ExpandFacets

Settings from configuration

$ ExpandFacets#searchObjectProperty in class ExpandFacets

Search results

ExpandFacets::setConfig() — Method in class ExpandFacets

Store the configuration of the recommendation module.

ExternalSearch::setConfig() — Method in class ExternalSearch

Store the configuration of the recommendation module.

FavoriteFacets::setConfig() — Method in class FavoriteFacets

Store the configuration of the recommendation module.

$ Libraryh3lp#skinProperty in class Libraryh3lp

Widget skin number

Libraryh3lp::setConfig() — Method in class Libraryh3lp

Store the configuration of the recommendation module.

$ MapSelection#selectedCoordinatesProperty in class MapSelection

Selected coordinates

$ MapSelection#searchParamsProperty in class MapSelection

Search parameters

$ MapSelection#searchResultCoordsProperty in class MapSelection

Search Results coordinates

$ MapSelection#searchServiceProperty in class MapSelection

Search service

$ MapSelection#searchQueryProperty in class MapSelection

Query Object

$ MapSelection#searchFiltersProperty in class MapSelection

Backend Parameters / Search Filters

MapSelection::setConfig() — Method in class MapSelection
SetConfig
$ OpenLibrarySubjects#subjectProperty in class OpenLibrarySubjects

Subject to search for

$ OpenLibrarySubjects#subjectTypesProperty in class OpenLibrarySubjects

Subject types to use

OpenLibrarySubjects::setConfig() — Method in class OpenLibrarySubjects

Store the configuration of the recommendation module.

OpenLibrarySubjectsDeferred::setConfig() — Method in class OpenLibrarySubjectsDeferred

Store the configuration of the recommendation module.

$ PubDateVisAjax#settingsProperty in class PubDateVisAjax

Raw settings string

$ PubDateVisAjax#searchObjectProperty in class PubDateVisAjax

Search results object

PubDateVisAjax::setConfig() — Method in class PubDateVisAjax

Store the configuration of the recommendation module.

$ RandomRecommend#settingsProperty in class RandomRecommend

Settings from configuration

$ RandomRecommend#searchServiceProperty in class RandomRecommend

Search Service

RandomRecommend::setConfig() — Method in class RandomRecommend

Store the configuration of the recommendation module.

RecommendInterface::setConfig() — Method in class RecommendInterface

Store the configuration of the recommendation module.

RecommendLinks::setConfig() — Method in class RecommendLinks

Store the configuration of the recommendation module.

RemoveFilters::setConfig() — Method in class RemoveFilters

Store the configuration of the recommendation module.

SearchObjectClass in namespace VuFind\Recommend

Abstract SearchObject Recommendations Module (needs to be extended to use a particular search object).

SearchObject::setConfig() — Method in class SearchObject

Store the configuration of the recommendation module.

SideFacetsClass in namespace VuFind\Recommend

SideFacets Recommendations Module

$ SideFacets#showDynamicCheckboxFacetsProperty in class SideFacets

Should we display dynamically-generated checkbox facets that are not explicitly configured in $checkboxFacets?

$ SideFacets#showInLightboxSettingsProperty in class SideFacets

Settings controlling how lightbox is used for facet display.

$ SideFacets#showMoreSettingsProperty in class SideFacets

Settings controlling how many values to display before "show more."

SideFacets::setConfig() — Method in class SideFacets

Store the configuration of the recommendation module.

SideFacetsDeferredClass in namespace VuFind\Recommend

SideFacetsDeferred Recommendations Module

SideFacetsFactoryClass in namespace VuFind\Recommend

SideFacets recommendation module factory.

SpellingSuggestionsClass in namespace VuFind\Recommend

SpellingSuggestions Recommendations Module

SummonBestBetsClass in namespace VuFind\Recommend

SummonBestBets Recommendations Module

SummonBestBetsDeferredClass in namespace VuFind\Recommend

SummonBestBetsDeferred Recommendations Module

SummonDatabasesClass in namespace VuFind\Recommend

SummonDatabases Recommendations Module

SummonDatabasesDeferredClass in namespace VuFind\Recommend

SummonDatabasesDeferred Recommendations Module

SummonResultsClass in namespace VuFind\Recommend

SummonResults Recommendations Module

SummonResultsDeferredClass in namespace VuFind\Recommend

SummonResultsDeferred Recommendations Module

SummonTopicsClass in namespace VuFind\Recommend

SummonTopics Recommendations Module

SwitchQueryClass in namespace VuFind\Recommend

SwitchQuery Recommendations Module

$ SwitchQuery#searchServiceProperty in class SwitchQuery

Search service.

$ SwitchQuery#suggestionsProperty in class SwitchQuery

Improved query suggestions.

$ SwitchQuery#skipChecksProperty in class SwitchQuery

Names of checks that should be skipped. These should correspond with check method names -- e.g. to skip the check found in the checkWildcard() method, you would put 'wildcard' into this array.

SwitchQuery::setConfig() — Method in class SwitchQuery

Store the configuration of the recommendation module.

SwitchQueryFactoryClass in namespace VuFind\Recommend

SwitchQuery recommendation module factory.

SwitchTabClass in namespace VuFind\Recommend

SwitchType Recommendations Module

SwitchTab::setConfig() — Method in class SwitchTab

Store the configuration of the recommendation module.

SwitchTab::setTabSelections() — Method in class SwitchTab

Set the tab state based on the current tabConfig.

SwitchTypeClass in namespace VuFind\Recommend

SwitchType Recommendations Module

SwitchType::setConfig() — Method in class SwitchType

Store the configuration of the recommendation module.

TopFacets::setConfig() — Method in class TopFacets

Store the configuration of the recommendation module.

VisualFacets::setConfig() — Method in class VisualFacets

Store the configuration of the recommendation module.

$ WorldCatIdentities#searchObjectProperty in class WorldCatIdentities

Search results object

$ WorldCatIdentities#settingsProperty in class WorldCatIdentities

Configuration settings

WorldCatIdentities::setConfig() — Method in class WorldCatIdentities

Store the configuration of the recommendation module.

AbstractBase::setRawData() — Method in class AbstractBase

Set raw data to initialize the object.

AbstractBase::supportsAjaxStatus() — Method in class AbstractBase

Returns true if the record supports real-time AJAX status lookups.

AbstractBase::supportsOpenUrl() — Method in class AbstractBase

Checks the current record if it's supported for generating OpenURLs.

AbstractBase::supportsCoinsOpenUrl() — Method in class AbstractBase

Checks the current record if it's supported for generating COinS-OpenURLs.

AbstractBase::setExtraDetail() — Method in class AbstractBase

Store a piece of supplemental information in the record driver.

$ EIT#sourceIdentifierProperty in class EIT

Used for identifying search backends

EIT::setRawData() — Method in class EIT

Set raw data to initialize the object.

HierarchyAwareTrait::setHierarchyDriverManager() — Method in class HierarchyAwareTrait

Inject a hierarchy driver plugin manager.

IlsAwareTrait::setIlsBackends() — Method in class IlsAwareTrait

Set the list of backends that support ILS integration.

IlsAwareTrait::supportsAjaxStatus() — Method in class IlsAwareTrait

Returns true if the record supports real-time AJAX status lookups.

$ MarcAdvancedTrait#subjectFieldsProperty in class MarcAdvancedTrait

Fields that may contain subject headings, and their descriptions

$ MarcAdvancedTrait#subjectSourcesProperty in class MarcAdvancedTrait

Mappings from subject source indicators (2nd indicator of subject fields in MARC 21) to the their codes.

PreviousUniqueIdInterface::setPreviousUniqueId() — Method in class PreviousUniqueIdInterface

Set previous unique ID

PreviousUniqueIdTrait::setPreviousUniqueId() — Method in class PreviousUniqueIdTrait

Set previous unique ID

Pazpar2::setRawData() — Method in class Pazpar2

Set raw data to initialize the object.

Search2DefaultClass in namespace VuFind\RecordDriver

Default model for Search2 records -- used when a more specific model based on the record_format field cannot be found.

$ Search2Default#sourceIdentifierProperty in class Search2Default

Used for identifying search backends

SolrArchivesSpaceClass in namespace VuFind\RecordDriver

Model for ArchivesSpace records in Solr.

SolrAuthDefaultClass in namespace VuFind\RecordDriver

Model for Solr authority records.

SolrAuthMarcClass in namespace VuFind\RecordDriver

Model for MARC authority records in Solr.

SolrDefaultClass in namespace VuFind\RecordDriver

Default model for Solr records -- used when a more specific model based on the record_format field cannot be found.

$ SolrDefault#snippetCaptionsProperty in class SolrDefault

These are captions corresponding with Solr fields for use when displaying snippets.

$ SolrDefault#snippetProperty in class SolrDefault

Should we include snippets in search results?

$ SolrDefault#searchServiceProperty in class SolrDefault

Search results plugin manager

SolrDefault::setHighlightDetails() — Method in class SolrDefault

Add highlighting details to the object.

SolrDefaultFactoryClass in namespace VuFind\RecordDriver

Factory for SolrDefault record drivers.

SolrDefaultWithoutSearchServiceFactoryClass in namespace VuFind\RecordDriver

Factory for SolrDefault-based record drivers that do not need a search service.

SolrMarcClass in namespace VuFind\RecordDriver

Model for MARC records in Solr.

SolrMarcRemoteClass in namespace VuFind\RecordDriver

Model for MARC records without a fullrecord in Solr. The fullrecord is being retrieved from an external source.

SolrOverdriveClass in namespace VuFind\RecordDriver

VuFind Record Driver for SolrOverdrive Records

SolrOverdrive::supportsOpenUrl() — Method in class SolrOverdrive

Supports OpenURL

SolrOverdrive::supportsCoinsOpenUrl() — Method in class SolrOverdrive

Supports coins OpenURL

SolrOverdrive::supportsAjaxStatus() — Method in class SolrOverdrive

Returns true if the record supports real-time AJAX status lookups.

SolrOverdriveFactoryClass in namespace VuFind\RecordDriver

Factory for Overdrive record drivers.

SolrReservesClass in namespace VuFind\RecordDriver

Model for Solr reserves records.

SolrWebClass in namespace VuFind\RecordDriver

Model for Solr web records.

SolrWebFactoryClass in namespace VuFind\RecordDriver

Factory for SolrWeb record drivers.

SummonClass in namespace VuFind\RecordDriver

Model for Summon records.

$ Summon#subjectFieldsProperty in class Summon

Fields that may contain subject headings, and their descriptions

Summon::supportsOpenUrl() — Method in class Summon

Checks the current record if it's supported for generating OpenURLs.

Summon::setDateConverter() — Method in class Summon

Pass in a date converter

SummonFactoryClass in namespace VuFind\RecordDriver

Factory for Summon record drivers.

WorldCat::setRawData() — Method in class WorldCat

Set raw data to initialize the object.

AbstractBase::supportsAjax() — Method in class AbstractBase

Can this tab be loaded via AJAX?

AbstractBase::setRecordDriver() — Method in class AbstractBase

Set the record driver

AbstractBase::setRequest() — Method in class AbstractBase

Set the user request

$ CollectionList#searchClassIdProperty in class CollectionList

Search class id

CollectionList::supportsAjax() — Method in class CollectionList

Can this tab be loaded via AJAX?

$ ComponentParts#searchServiceProperty in class ComponentParts

Search service

HierarchyTree::searchActive() — Method in class HierarchyTree

Is tree searching active?

HierarchyTree::supportsAjax() — Method in class HierarchyTree

Can this tab be loaded via AJAX?

$ HoldingsWorldCat#searchServiceProperty in class HoldingsWorldCat

Search service

Map::supportsAjax() — Method in class Map

Can this tab be loaded via AJAX?

Preview::supportsAjax() — Method in class Preview

Can this tab be loaded via AJAX?

Search2CollectionListClass in namespace VuFind\RecordTab

Search 2 Collection list tab

$ Search2CollectionList#searchClassIdProperty in class Search2CollectionList

Backend id

SimilarItemsCarouselClass in namespace VuFind\RecordTab

Similar items carousel tab.

$ SimilarItemsCarousel#searchServiceProperty in class SimilarItemsCarousel

Search service

SimilarItemsCarouselFactoryClass in namespace VuFind\RecordTab

Factory for building the SimilarItemsCarousel tab.

StaffViewArrayClass in namespace VuFind\RecordTab

Staff view (array dump) tab

StaffViewMARCClass in namespace VuFind\RecordTab

Staff view (MARC dump) tab

StaffViewOverdriveClass in namespace VuFind\RecordTab

Staff view (array dump) tab

TabManager::setContext() — Method in class TabManager

Set and (if necessary) initialize the context.

$ Versions#searchOptionsManagerProperty in class Versions

Search options plugin manager

Cache::setContext() — Method in class Cache

Set the context for controlling cache behaviour

RecordCacheAwareInterface::setRecordCache() — Method in class RecordCacheAwareInterface

Set record cache

RecordCacheAwareTrait::setRecordCache() — Method in class RecordCacheAwareTrait

Set record cache

$ AbstractFallbackLoader#sourceProperty in class AbstractFallbackLoader

Record source

$ AbstractFallbackLoader#searchServiceProperty in class AbstractFallbackLoader

Search service

SolrClass in namespace VuFind\Record\FallbackLoader

Solr record fallback loader

$ Solr#sourceProperty in class Solr

Record source

SolrFactoryClass in namespace VuFind\Record\FallbackLoader

Solr record fallback loader factory

SummonClass in namespace VuFind\Record\FallbackLoader

Summon record fallback loader

$ Summon#sourceProperty in class Summon

Record source

$ Loader#searchServiceProperty in class Loader

Search service

Loader::setCacheContext() — Method in class Loader

Set the context to control cache behavior

SourceAndIdListClass in namespace VuFind\Record

Record ID list (support class for Loader)

SimilarClass in namespace VuFind\Related

Related Records: Solr-based similarity

$ Similar#searchServiceProperty in class Similar

Search service

SimilarFactoryClass in namespace VuFind\Related

Factory for Similar related record module (and subclasses).

AbstractBase::supportsMoreOptionsLink() — Method in class AbstractBase

This controls whether a "More options" link will be shown below the fetched resolver links eventually linking to the resolver page previously being parsed.

DriverInterface::supportsMoreOptionsLink() — Method in class DriverInterface

This controls whether a "More options" link will be shown below the fetched resolver links eventually linking to the resolver page previously being parsed.

Jop::supportsMoreOptionsLink() — Method in class Jop

Allows for resolver driver specific enabling/disabling of the more options link which will link directly to the resolver URL. This should return false if the resolver returns data in XML or any other human unfriendly response.

SfxClass in namespace VuFind\Resolver\Driver

SFX Link Resolver Driver

PermissionDeniedManager::setDefaultDeniedControllerBehavior() — Method in class PermissionDeniedManager

Set the default behavior for a denied controller permission

PermissionDeniedManager::setDefaultDeniedTemplateBehavior() — Method in class PermissionDeniedManager

Set the default behavior for a denied template permission

ServerParamClass in namespace VuFind\Role\PermissionProvider

ServerParam permission provider for VuFind.

$ ServerParam#serverParamDelimiterProperty in class ServerParam

Delimiter for multi-valued server params (default: none)

$ ServerParam#serverParamEscapeProperty in class ServerParam

Escape character for delimiter in server param strings (default: none)

ServerParam::splitString() — Method in class ServerParam

Split string on delimiter unless dequalified with escape

ShibbolethClass in namespace VuFind\Role\PermissionProvider

Shibboleth permission provider for VuFind.

ShibbolethFactoryClass in namespace VuFind\Role\PermissionProvider

Factory for instantiating Shibboleth permission provider.

$ AbstractBase#smsConfigProperty in class AbstractBase

SMS configuration

SMSInterfaceClass in namespace VuFind\SMS

Interface for SMS classes.

$ HideFacetValueListener#showFacetsProperty in class HideFacetValueListener

List of facet values to show, indexed by facet field. All other facets are hidden.

HierarchicalFacetHelperInterface::sortFacetList() — Method in class HierarchicalFacetHelperInterface

Helper method for building hierarchical facets: Sort a facet list according to the given sort order

$ Options#sortOptionsProperty in class Options

Available sort options

$ Options#specialAdvancedFacetsProperty in class Options

Special advanced facet settings

$ Options#spellcheckProperty in class Options

Spelling setting

$ Options#shardsProperty in class Options

Available shards

$ Options#searchIniProperty in class Options

Configuration file to read search settings from

Options::setConfigLoader() — Method in class Options

Set the config loader

Options::setLimitOptions() — Method in class Options

Override the limit options.

Options::setDefaultFacetDelimiter() — Method in class Options

Set the defaultFacetDelimiter value.

Options::setDelimitedFacets() — Method in class Options

Set the delimitedFacets value.

Options::setTranslatedFacets() — Method in class Options

Configure facet translation using an array of field names with optional colon-separated text domains.

Options::spellcheckEnabled() — Method in class Options

Get current spellcheck setting and (optionally) change it.

Options::supportsCart() — Method in class Options

Does this search option support the cart/book bag?

Options::showShardCheckboxes() — Method in class Options

Should we display shard checkboxes for this object?

Options::supportsFirstLastNavigation() — Method in class Options

Should we include first/last options in result scroller navigation?

Options::supportsScheduledSearch() — Method in class Options

Does this search backend support scheduled searching?

$ Params#sortProperty in class Params

Sort setting

$ Params#skipRssSortProperty in class Params

Override special RSS sort feature?

$ Params#searchTypeProperty in class Params

Search type (basic or advanced)

$ Params#selectedShardsProperty in class Params
Shards
Params::setOptions() — Method in class Params

Set the search options object.

Params::setBasicSearch() — Method in class Params

Set a basic search query:

Params::setLastView() — Method in class Params

Set the last value of the view parameter (if available in session).

Params::setLimit() — Method in class Params

Change the value of the limit

Params::setPage() — Method in class Params

Change the page

Params::setSort() — Method in class Params

Set the sorting value (note: sort will be set to default if an illegal or empty value is passed in).

Params::setView() — Method in class Params

Set the value for which search view we use

Params::setQueryIDs() — Method in class Params

Override the normal search behavior with an explicit array of IDs that must be retrieved.

Params::setOverrideQuery() — Method in class Params

Set the override query

$ Results#startRecordOverrideProperty in class Results

Override (only for use in very rare cases)

$ Results#searchIdProperty in class Results

An ID number for saving/retrieving search

$ Results#savedSearchProperty in class Results

Is this a user-saved search?

$ Results#suggestionsProperty in class Results

Spelling suggestions

$ Results#searchServiceProperty in class Results

Search service.

Results::setParams() — Method in class Results

Set the search parameters object.

Results::setHelper() — Method in class Results

Override a helper object.

Results::startQueryTimer() — Method in class Results

Start the timer to figure out how long a query takes. Complements stopQueryTimer().

Results::stopQueryTimer() — Method in class Results

End the timer to figure out how long a query takes. Complements startQueryTimer().

Results::setExtraData() — Method in class Results

Set extra data for the search.

Results::setRecommendations() — Method in class Results

Set the recommendation objects (see \VuFind\Search\RecommendListener).

Results::setUrlQueryHelperFactory() — Method in class Results

Set URL query helper factory

Results::setHierarchicalFacetHelper() — Method in class Results

Set hierarchical facet helper

$ Params#searchParamsProperty in class Params

Search params for backends

Params::setBasicSearch() — Method in class Params

Set a basic search query:

Params::setSort() — Method in class Params

Set the sorting value (note: sort will be set to default if an illegal or empty value is passed in).

Options::supportsCart() — Method in class Options

Does this search option support the cart/book bag?

$ Options#searchModeProperty in class Options

The set search mode

$ Options#searchSettingsProperty in class Options

Search configuration

Options::setSearchMode() — Method in class Options

Set the search mode

Options::setOptionsFromApi() — Method in class Options

Set the search options from the Eds API Info methods results

Options::setCommonSettings() — Method in class Options

Apply user-requested "common" settings.

Options::setOptionsFromConfig() — Method in class Options

Load options from the configuration file.

$ AbstractBackendFactory#serviceLocatorProperty in class AbstractBackendFactory

Service container.

AbstractBackendFactory::setup() — Method in class AbstractBackendFactory

Initialize the factory

$ AbstractSolrBackendFactory#searchConfigProperty in class AbstractSolrBackendFactory

Search configuration file identifier.

$ AbstractSolrBackendFactory#searchYamlProperty in class AbstractSolrBackendFactory

YAML searchspecs filename.

$ AbstractSolrBackendFactory#solrCoreProperty in class AbstractSolrBackendFactory

Solr core name

$ BlenderBackendFactory#searchConfigProperty in class BlenderBackendFactory

Search configuration file identifier.

Search2BackendFactoryClass in namespace VuFind\Search\Factory

Factory for a second Solr backend

SharedListenersTraitClass in namespace VuFind\Search\Factory

Trait containing methods for building shared listeners.

SolrAuthBackendFactoryClass in namespace VuFind\Search\Factory

Factory for the authority SOLR backend.

SolrDefaultBackendFactoryClass in namespace VuFind\Search\Factory

Factory for the default SOLR backend.

SolrReservesBackendFactoryClass in namespace VuFind\Search\Factory

Factory for the reserves SOLR backend.

SolrWebBackendFactoryClass in namespace VuFind\Search\Factory

Factory for the website SOLR backend.

SummonBackendFactoryClass in namespace VuFind\Search\Factory

Factory for Summon backends.

$ SummonBackendFactory#summonConfigProperty in class SummonBackendFactory

Summon configuration

$ History#searchTableProperty in class History

Search table

$ History#sessionIdProperty in class History

Current session ID

Options::supportsCart() — Method in class Options

Does this search option support the cart/book bag?

$ Memory#sessionProperty in class Memory

Session container

$ Minified#sProperty in class Minified

Search duration

Params::setRecordIdsFromFilter() — Method in class Params

Parse record ids from a filter value and set as the ID list.

FacetLimitTrait::setFacetLimit() — Method in class FacetLimitTrait

Set Facet Limit

FacetLimitTrait::setFacetLimitByField() — Method in class FacetLimitTrait

Set Facet Limit by Field

FacetLimitTrait::setHierarchicalFacetLimit() — Method in class FacetLimitTrait

Set limit for hierarchical facets

FacetRestrictionsTrait::setFacetPrefixByField() — Method in class FacetRestrictionsTrait

Set Facet Prefix by Field

FacetRestrictionsTrait::setFacetMatchesByField() — Method in class FacetRestrictionsTrait

Set Facet Matches by Field

Options::supportsCart() — Method in class Options

Does this search option support the cart/book bag?

InjectOnCampusListener::setPermissionHandler() — Method in class InjectOnCampusListener
Constructor.
PrimoPermissionHandler::setInstCode() — Method in class PrimoPermissionHandler

Set the institution code (no autodetection)

$ RecommendListener#searchIdProperty in class RecommendListener

The ID of the search for which this listener should respond. Value is set by \VuFind\Search\SearchRunner and makes sure that each search run by the runner is handled by its own independent RecommendListener. Otherwise, the wrong recommendations might be injected into the wrong objects!

RecommendListener::setConfig() — Method in class RecommendListener

Set configuration

SearchNormalizerClass in namespace VuFind\Search

Search normalizer.

SearchNormalizerFactoryClass in namespace VuFind\Search

Search normalizer factory.

SearchRunnerClass in namespace VuFind\Search

VuFind Search Runner

$ SearchRunner#searchIdProperty in class SearchRunner

Counter of how many searches we have run (for differentiating listeners).

SearchRunner::setEventManager() — Method in class SearchRunner

Set EventManager instance.

SearchRunnerFactoryClass in namespace VuFind\Search

Search runner factory.

SearchTabsHelperClass in namespace VuFind\Search

"Search tabs" helper

$ SearchTabsHelper#settingsProperty in class SearchTabsHelper

Tab settings

SearchTabsHelperFactoryClass in namespace VuFind\Search

Search tabs helper factory.

Options::supportsCart() — Method in class Options

Does this search option support the cart/book bag?

Options::supportsCart() — Method in class Options

Does this search option support the cart/book bag?

$ DeduplicationListener#serviceLocatorProperty in class DeduplicationListener

Service container.

$ DeduplicationListener#searchConfigProperty in class DeduplicationListener

Search configuration file identifier.

HierarchicalFacetHelper::sortFacetList() — Method in class HierarchicalFacetHelper

Helper method for building hierarchical facets: Sort a facet list according to the given sort order

$ HierarchicalFacetListener#serviceLocatorProperty in class HierarchicalFacetListener

Service container.

$ HierarchicalFacetListener#separatorsProperty in class HierarchicalFacetListener

Hierarchy level separators

$ MultiIndexListener#shardsProperty in class MultiIndexListener

Available shards, indexed by name.

$ MultiIndexListener#stripfieldsProperty in class MultiIndexListener

Fields to strip, indexed by shard name.

$ MultiIndexListener#specsProperty in class MultiIndexListener

Base search specs.

MultiIndexListener::stripSpecsQueryFields() — Method in class MultiIndexListener

Strip fields from a search specs QueryFields section.

$ Options#sortTieBreakerProperty in class Options

Solr field to be used as a tie-breaker.

Options::supportsScheduledSearch() — Method in class Options

Does this search backend support scheduled searching?

$ Params#searchingByIdProperty in class Params

Are we searching by ID only (instead of a normal query)?

Params::setFacetContains() — Method in class Params

Set Facet Contains

Params::setFacetContainsIgnoreCase() — Method in class Params

Set Facet Contains Ignore Case

Params::setFacetOffset() — Method in class Params

Set Facet Offset

Params::setFacetPrefix() — Method in class Params

Set Facet Prefix

Params::setFacetSort() — Method in class Params

Set Facet Sorting

Params::setIndexSortedFacets() — Method in class Params

Set Index Facet Sorting

Params::setQueryIDs() — Method in class Params

Override the normal search behavior with an explicit array of IDs that must be retrieved.

Params::setPivotFacets() — Method in class Params

Set pivot facet fields to use for visual results

$ Results#spellingQueryProperty in class Results

Currently used spelling query, if any.

$ Results#spellingProcessorProperty in class Results

Class to process spelling.

Results::setSpellingProcessor() — Method in class Results

Set spelling processor.

Results::setCursorMark() — Method in class Results

Set cursorMark.

SpellingProcessorClass in namespace VuFind\Search\Solr

Solr spelling processor.

$ SpellingProcessor#spellingLimitProperty in class SpellingProcessor

Spelling limit

$ SpellingProcessor#spellSkipNumericProperty in class SpellingProcessor

Spell check words with numbers in them?

SpellingProcessor::shouldSkipNumericSpelling() — Method in class SpellingProcessor

Are we skipping numeric words?

SpellingProcessor::shouldSkipTerm() — Method in class SpellingProcessor

Should we skip the specified term?

Options::setMaxTopicRecommendations() — Method in class Options

Set the maximum number of topic recommendations (false for none)

Results::stripFilterParameters() — Method in class Results

Support method for getFacetList() -- strip extra parameters from field names.

UrlQueryHelper::setDefaultParameter() — Method in class UrlQueryHelper

Set the default value of a parameter, and add that parameter to the object if it is not already defined.

UrlQueryHelper::setSuppressQuery() — Method in class UrlQueryHelper

Control query suppression

UrlQueryHelper::setPage() — Method in class UrlQueryHelper

Return HTTP parameters to render a different page of results.

UrlQueryHelper::setSort() — Method in class UrlQueryHelper

Return HTTP parameters to render the current page with a different sort parameter.

UrlQueryHelper::setHandler() — Method in class UrlQueryHelper

Return HTTP parameters to render the current page with a different search handler.

UrlQueryHelper::setViewParam() — Method in class UrlQueryHelper

Return HTTP parameters to render the current page with a different view parameter.

UrlQueryHelper::setLimit() — Method in class UrlQueryHelper

Return HTTP parameters to render the current page with a different limit parameter.

UrlQueryHelper::setSearchTerms() — Method in class UrlQueryHelper

Return HTTP parameters to render the current page with a different set of search terms.

ServiceInitializerClass in namespace VuFind\ServiceManager

VuFind Service Initializer

MarkdownFactory::sanitizeConfig() — Method in class MarkdownFactory

Sanitize some config options

SearchServiceFactoryClass in namespace VuFind\Service

VuFind Search Service factory.

ServiceWithConfigIniFactoryClass in namespace VuFind\Service

Generic factory to constructor-inject the config.ini settings.

AbstractBase::saveSession() — Method in class AbstractBase

A function that is called internally when session data is to be saved.

Database::saveSession() — Method in class Database

A function that is called internally when session data is to be saved.

File::saveSession() — Method in class File

A function that is called internally when session data is to be saved.

Memcache::saveSession() — Method in class Memcache

A function that is called internally when session data is to be saved.

Redis::saveSession() — Method in class Redis

Write function that is called when session data is to be saved.

SecureDelegatorClass in namespace VuFind\Session

Secure session delegator

SecureDelegatorFactoryClass in namespace VuFind\Session

Secure session delegator factory

SettingsClass in namespace VuFind\Session

Container for session settings, allowing those settings to be configured "just in case" they are needed, without invoking the heavy weight of instantiating the session itself. See \VuFind\Session\ManagerFactory for details on the use of this object.

Settings::setSessionManager() — Method in class Settings

Set a session manager instance.

SimpleXMLClass in namespace VuFind

VuFind SimpleXML enhancement functionality

Generator::setVerbose() — Method in class Generator

Get/set verbose callback

Generator::setBaseUrl() — Method in class Generator

Get/set base url

Generator::setBaseSitemapUrl() — Method in class Generator

Get/set base sitemap url

Generator::setFileLocation() — Method in class Generator

Get/set output file path

AbstractGeneratorPlugin::setOptions() — Method in class AbstractGeneratorPlugin

Set plugin options.

AbstractGeneratorPlugin::supportsVuFindLanguages() — Method in class AbstractGeneratorPlugin

Whether the URLs generated by the plugin support VuFind's lng parameter

ContentPages::setOptions() — Method in class ContentPages

Set plugin options.

GeneratorPluginInterface::setOptions() — Method in class GeneratorPluginInterface

Set plugin options.

GeneratorPluginInterface::supportsVuFindLanguages() — Method in class GeneratorPluginInterface

Whether the URLs generated by the plugin support VuFind's lng parameter

Index::setOptions() — Method in class Index

Set plugin options.

$ AbstractIdFetcher#searchServiceProperty in class AbstractIdFetcher

Search service

AbstractIdFetcher::setupBackend() — Method in class AbstractIdFetcher

Set up the backend.

CursorMarkIdFetcher::setupBackend() — Method in class CursorMarkIdFetcher

Set up the backend.

TermsIdFetcher::setupBackend() — Method in class TermsIdFetcher

Set up the backend.

StartPageClass in namespace VuFind\Sitemap\Plugin

Start page generator plugin

StartPage::setOptions() — Method in class StartPage

Set plugin options.

SitemapClass in namespace VuFind\Sitemap

Class for representing sitemap files

SitemapIndexClass in namespace VuFind\Sitemap

Class for representing sitemap index files

Utils::sanitizeDate() — Method in class Utils

Convert a raw string date (as, for example, from a MARC record) into a legal Solr date string. Return null if conversion is impossible.

$ Writer#searchServiceProperty in class Writer

Search service

Writer::save() — Method in class Writer

Save new record(s) to the index.

$ Database#saltProperty in class Database

HMacKey from config

Database::saveAndShortenHash() — Method in class Database

Support method for getGenericHash(): do the work of picking a short version of the hash and writing to the database as needed.

Database::shorten() — Method in class Database

Generate & store shortened URL in Database.

None::shorten() — Method in class None

Dummy to return original URL version.

ServiceFactoryClass in namespace VuFind\UrlShortener

Factory to construct the configured UrlShortener service.

UrlShortenerInterface::shorten() — Method in class UrlShortenerInterface

Generate and return shortened version of a URL.

SessionCsrfClass in namespace VuFind\Validator

Extension of Laminas\Validator\Csrf with token counting/clearing functions added.

SessionCsrfFactoryClass in namespace VuFind\Validator

CSRF Validator factory.

$ AbstractLayoutClass#sidebarOnLeftProperty in class AbstractLayoutClass

Does the sidebar go on the left?

SearchClass in namespace VuFind\View\Helper\Bootstrap3

Helper class for displaying search-related HTML chunks.

$ AbstractJsStrings#stringsProperty in class AbstractJsStrings

Strings to convey (key = js key, value = value to map)

Citation::stripPunctuation() — Method in class Citation

Strip unwanted punctuation from the right side of a string.

$ Highlight#startTagProperty in class Highlight

Start tag for highlighitng

$ Icon#styleAppendedProperty in class Icon

Prevent extra work by only appending the stylesheet once

$ Matomo#siteIdProperty in class Matomo

Matomo Site ID

$ Matomo#searchPrefixProperty in class Matomo

Search prefix (see config.ini for details)

Overdrive::showMyContentLink() — Method in class Overdrive

Is Overdrive content active?

Overdrive::showOverdriveAdminLink() — Method in class Overdrive

Show the Overdrive API Admin Menu Item?

$ Piwik#siteIdProperty in class Piwik

Piwik Site ID

$ Piwik#searchPrefixProperty in class Piwik

Search prefix (see config.ini for details)

Record::setCoverRouter() — Method in class Record

Inject the cover router

RecordDataFormatter::sortCallback() — Method in class RecordDataFormatter

Sort callback for field specification.

RecordDataFormatter::setDefaults() — Method in class RecordDataFormatter

Set default configuration.

SpecBuilderClass in namespace VuFind\View\Helper\Root\RecordDataFormatter

Specification builder for record driver data formatting view helper

$ SpecBuilder#specProperty in class SpecBuilder
Spec
SpecBuilder::setLine() — Method in class SpecBuilder

Set a generic spec line.

SpecBuilder::setMultiLine() — Method in class SpecBuilder

Construct a multi-function template spec line.

SpecBuilder::setTemplateLine() — Method in class SpecBuilder

Construct a record driver template spec line.

ResultFeed::setOverrideTitle() — Method in class ResultFeed

Set override title.

SafeMoneyFormatClass in namespace VuFind\View\Helper\Root

Safe money format view helper

SafeMoneyFormatFactoryClass in namespace VuFind\View\Helper\Root

SafeMoneyFormat helper factory.

SearchBoxClass in namespace VuFind\View\Helper\Root

Search box view helper

SearchBoxFactoryClass in namespace VuFind\View\Helper\Root

SearchBox helper factory.

SearchMemoryClass in namespace VuFind\View\Helper\Root

View helper for remembering recent user searches/parameters.

SearchMemoryFactoryClass in namespace VuFind\View\Helper\Root

SearchMemory helper factory.

SearchOptionsClass in namespace VuFind\View\Helper\Root

"Retrieve search options" view helper

SearchOptionsFactoryClass in namespace VuFind\View\Helper\Root

SearchOptions helper factory.

SearchParamsClass in namespace VuFind\View\Helper\Root

"Retrieve search params" view helper

SearchParamsFactoryClass in namespace VuFind\View\Helper\Root

SearchParams helper factory.

SearchTabsClass in namespace VuFind\View\Helper\Root

"Search tabs" view helper

SearchTabsFactoryClass in namespace VuFind\View\Helper\Root

SearchTabs helper factory.

ServerUrlFactoryClass in namespace VuFind\View\Helper\Root

ServerUrl helper factory.

ShortenUrlClass in namespace VuFind\View\Helper\Root

View helper for formatting dates and times

$ ShortenUrl#shortenerProperty in class ShortenUrl

URL shortener

ShortenUrlFactoryClass in namespace VuFind\View\Helper\Root

ShortenUrl helper factory.

SortFacetListClass in namespace VuFind\View\Helper\Root

Sort facet list view helper

SortFacetListFactoryClass in namespace VuFind\View\Helper\Root

Class SortFacetListFactory

SorterClass in namespace VuFind\View\Helper\Root

Class Sorter

SorterFactoryClass in namespace VuFind\View\Helper\Root

Class SorterFactory

SummonClass in namespace VuFind\View\Helper\Root

Summon support functions.

SyndeticsPlusClass in namespace VuFind\View\Helper\Root

SyndeticsPlus view helper

SyndeticsPlusFactoryClass in namespace VuFind\View\Helper\Root

SyndeticsPlus helper factory.

SystemEmailClass in namespace VuFind\View\Helper\Root

System contact email helper.

SystemEmailFactoryClass in namespace VuFind\View\Helper\Root

SystemEmail helper factory.

$ UserList#sessionProperty in class UserList

Session container for last list information.

$ VuFind#serviceLocatorProperty in class VuFind

Service locator

VuFind::setServiceLocator() — Method in class VuFind

Set the service locator.

VuFind::stripBadChars() — Method in class VuFind

Strip illegal XML characters from a string.

VuFind::stripArticles() — Method in class VuFind

Strip articles from the front of the text (for creating sortable titles).

$ Importer#serviceLocatorProperty in class Importer

Service locator

Importer::save() — Method in class Importer

Save an XML file to the Solr index using the specified configuration.

T

Cronjob::testAction() — Method in class Cronjob

Test endpoint

MultiBackendTest::testSiglaToSource() — Method in class MultiBackendTest

Test siglaToSource method

MultiBackendTest::testSourceToSigla() — Method in class MultiBackendTest

Test sourceToSigla method

$ XCNCIP2Test#transactionsTestsProperty in class XCNCIP2Test
$ XCNCIP2Test#transactionHistoryTestsProperty in class XCNCIP2Test

Transaction history tests

XCNCIP2Test::testGetStatuses() — Method in class XCNCIP2Test

Test getStatuses

XCNCIP2Test::testGetHolding() — Method in class XCNCIP2Test

Test getHolding

XCNCIP2Test::testGetPickupLocations() — Method in class XCNCIP2Test

Test getPickUpLocations

XCNCIP2Test::testGetMyTransactionHistory() — Method in class XCNCIP2Test

Test getMyTransactions

XCNCIP2Test::testGetStatusByItemId() — Method in class XCNCIP2Test

Test getStatusByItemId

XCNCIP2Test::testGetLookupUserHistoryRequest() — Method in class XCNCIP2Test

Test getLookupUserHistoryRequest

XCNCIP2Test::testParsePage() — Method in class XCNCIP2Test

Test parsePage method

XCNCIP2Test::testIsPatronBlocked() — Method in class XCNCIP2Test

Test method for isPatronBlocked

XCNCIP2Test::testAcceptOtherHttpStastusCodes() — Method in class XCNCIP2Test

Test other accepted HTTP status code configuration

XCNCIP2Test::testInvalidateResponseCache() — Method in class XCNCIP2Test

Test invalidateResponseCache

XCNCIP2Test::testGetBib() — Method in class XCNCIP2Test

Test getBib method

GetHolding::translateWithSource() — Method in class GetHolding

Translate with ILS source and domain

$ SolrPrefixHandler#typeProperty in class SolrPrefixHandler

Search type to use

$ AbstractDbAwaredRecordIds#tableManagerProperty in class AbstractDbAwaredRecordIds

Table manager

TemplateBasedClass in namespace KnihovnyCz\ContentBlock

Class TemplateBased

TemplateBasedFactoryClass in namespace KnihovnyCz\ContentBlock

Class TemplateBasedFactory

TemplateBasedForLoggedInClass in namespace KnihovnyCz\ContentBlock

Class TemplateBasedForLoggedIn

TemplateBasedForLoggedInFactoryClass in namespace KnihovnyCz\ContentBlock

Class TemplateBasedForLoggedInFactory

TemplateBasedForUnloggedInClass in namespace KnihovnyCz\ContentBlock

Class TemplateBasedHiddenForLoggedIn

TemplateBasedForUnloggedInFactoryClass in namespace KnihovnyCz\ContentBlock

Class TemplateBasedHiddenForLoggedInFactory

$ PageLocator#typesProperty in class PageLocator

Types/formats of content

MyResearchZiskejEddController::ticketAction() — Method in class MyResearchZiskejEddController

Ziskej ticket detail

MyResearchZiskejEddController::ticketCancelAction() — Method in class MyResearchZiskejEddController

Cancel Ziskej ticket

MyResearchZiskejEddController::ticketMessageAction() — Method in class MyResearchZiskejEddController

Send form: Create new message

MyResearchZiskejMvsController::ticketAction() — Method in class MyResearchZiskejMvsController

Ziskej ticket detail

MyResearchZiskejMvsController::ticketCancelAction() — Method in class MyResearchZiskejMvsController

Cancel Ziskej ticket

MyResearchZiskejMvsController::ticketMessageAction() — Method in class MyResearchZiskejMvsController

Send form: Create new message

FlashRedirect::toUrl() — Method in class FlashRedirect

Generate redirect response based on given URL and add to URL parameters with messages from flashMessenger

$ KohaRest1905#tokenEndpointProperty in class KohaRest1905
$ KohaRest1905#translationDomainProperty in class KohaRest1905

Domain used to translate messages from ILS

KohaRest1905::translateMessage() — Method in class KohaRest1905

Translate a message from ILS

InvolvedLibrariesParser::tryContinue() — Method in class InvolvedLibrariesParser

Attempt to parse the given line

InvolvedLibrariesParser::tryStart() — Method in class InvolvedLibrariesParser

Check whether we should handle the block at the current position

JsonFacetListener::transformFacets() — Method in class JsonFacetListener

Transform facets parameters for JSON API

JsonFacetListener::transformFacetQueries() — Method in class JsonFacetListener

Transform facet queries

$ Index#tabProperty in class Index

Record tab

DatabaseCsrf::trimTokenList() — Method in class DatabaseCsrf

Keep only the most recent N tokens. Not implemented here.

TextFormatterClass in namespace KnihovnyCz\View\Helper\KnihovnyCz

Class TextFormatter

SolrAuthorityTest::testGetStructuredDataFieldArray() — Method in class SolrAuthorityTest

Test getStructuredDataFieldArray

SolrLocalTest::testGetOfflineHoldings() — Method in class SolrLocalTest

Test getOfflineHoldings method

SolrLocalTest::testHasOfflineHoldings() — Method in class SolrLocalTest

Test hasOfflineHoldings method

SolrMarcTest::testGetStructuredDataFieldArray() — Method in class SolrMarcTest

Test getStructuredDataFieldArray

SolrMarcTest::testGetItemIds() — Method in class SolrMarcTest

Test getItemIds

TagsControllerClass in namespace VuFindAdmin\Controller

Class controls distribution of tags and resource tags.

ThemeCommandClass in namespace VuFindConsole\Command\Compile

Console command: Compile themes.

ThemeCommandFactoryClass in namespace VuFindConsole\Command\Compile

Factory for console command: Compile themes.

$ AbstractThemeCommand#typeProperty in class AbstractThemeCommand

Type of resource being generated (used in help messages)

ThemeCommandClass in namespace VuFindConsole\Command\Generate

Theme generator command.

$ ThemeCommand#typeProperty in class ThemeCommand

Type of resource being generated (used in help messages)

ThemeCommandFactoryClass in namespace VuFindConsole\Command\Generate

Factory for theme generator command.

ThemeMixinCommandClass in namespace VuFindConsole\Command\Generate

Theme mixin generator command.

$ ThemeMixinCommand#typeProperty in class ThemeMixinCommand

Type of resource being generated (used in help messages)

ThemeMixinCommandFactoryClass in namespace VuFindConsole\Command\Generate

Factory for theme mixin generator command.

$ AbstractExpireCommand#tableProperty in class AbstractExpireCommand

Table on which to expire rows

Backend::triggerSearchEvent() — Method in class Backend

Trigger pre-search events for all backends.

$ Connector#tokenProperty in class Connector

The API access token

$ BackendException#tagsProperty in class BackendException
Tags.
Connector::termlist() — Method in class Connector

Retrieves term list(s).

$ RecordCollection#totalProperty in class RecordCollection

Total records

Backend::terms() — Method in class Backend

Return terms from SOLR index.

$ WriteDocumentCommand#timeoutProperty in class WriteDocumentCommand

Timeout value.

Connector::terms() — Method in class Connector

Extract terms from a SOLR index.

Connector::trySolrUrls() — Method in class Connector

Try all Solr URLs until we find one that works (or throw an exception).

NamedList::toArray() — Method in class NamedList

Convert the named list into a standard associative array.

$ RecordCollection#templateProperty in class RecordCollection

Template of deserialized SOLR response.

$ Spellcheck#termsProperty in class Spellcheck

Spellcheck terms mapped to term information.

TermsClass in namespace VuFindSearch\Backend\Solr\Response\Json

SOLR Terms component.

$ Terms#termsProperty in class Terms

Terms, indexed by field.

SearchHandler::toArray() — Method in class SearchHandler

Serialize handler specs as array.

SearchHandler::tokenize() — Method in class SearchHandler

Tokenize the search string.

BackendTest::testRetrieve() — Method in class BackendTest

Test retrieving a record.

BackendTest::testRetrieveBatch() — Method in class BackendTest

Test retrieving multiple records.

BackendTest::testRetrieveWrapsSummonException() — Method in class BackendTest

Test retrieve exception handling.

BackendTest::testSearch() — Method in class BackendTest

Test performing a search.

BackendTest::testSearchWrapsSummonException() — Method in class BackendTest

Test search exception handling.

BackendTest::testMergedParamBag() — Method in class BackendTest

Test merged param bag.

BackendTest::testConstructorSetters() — Method in class BackendTest

Test setting a custom record collection factory.

BackendTest::testSetQueryBuilder() — Method in class BackendTest

Test setting a query builder.

TermsCommandClass in namespace VuFindSearch\Command

Fetch terms from the backend (currently only supported by Solr)

Service::triggerError() — Method in class Service

Trigger the error event.

Service::triggerPre() — Method in class Service

Trigger the pre event.

Service::triggerPost() — Method in class Service

Trigger the post event.

CheckRequestIsValidTest::testLoggedOutUser() — Method in class CheckRequestIsValidTest

Test the AJAX handler's response when no one is logged in.

CheckRequestIsValidTest::testEmptyQuery() — Method in class CheckRequestIsValidTest

Test the AJAX handler's response when the query is empty.

CheckRequestIsValidTest::testHoldResponse() — Method in class CheckRequestIsValidTest

Test a successful hold response.

CheckRequestIsValidTest::testILLResponse() — Method in class CheckRequestIsValidTest

Test a successful ILL response.

CheckRequestIsValidTest::testStorageResponse() — Method in class CheckRequestIsValidTest

Test a successful storage retrieval response.

CommentRecordTest::testDisabledResponse() — Method in class CommentRecordTest

Test the AJAX handler's response when comments are disabled.

CommentRecordTest::testLoggedOutUser() — Method in class CommentRecordTest

Test the AJAX handler's response when no one is logged in.

CommentRecordTest::testEmptyQuery() — Method in class CommentRecordTest

Test the AJAX handler's response when the query is empty.

CommentRecordTest::testSuccessfulTransaction() — Method in class CommentRecordTest

Test a successful scenario.

DoiLookupTest::testSingleLookup() — Method in class DoiLookupTest

Test a single DOI lookup.

DoiLookupTest::testFirstDefaultLookup() — Method in class DoiLookupTest

Test a DOI lookup in two handlers, with "first" mode turned on by default.

DoiLookupTest::testFirstExplicitLookup() — Method in class DoiLookupTest

Test a DOI lookup in two handlers, with "first" mode turned on explicitly.

DoiLookupTest::testFirstExplicitLookupMultipleDOIs() — Method in class DoiLookupTest

Test a DOI lookup in two handlers, with "first" mode turned on explicitly, where each handler returns results for a different DOI.

DoiLookupTest::testMergeLookup() — Method in class DoiLookupTest

Test a DOI lookup in two handlers, with "merge" mode turned on.

KeepAliveTest::testResponse() — Method in class KeepAliveTest

Test the AJAX handler's basic response.

RecommendTest::testResponse() — Method in class RecommendTest

Test the AJAX handler's basic response.

AuthTokenTest::testGetHeaderValue() — Method in class AuthTokenTest
AuthTokenTest::testIsExpired() — Method in class AuthTokenTest
AuthTokenTest::testGetExpiresIn() — Method in class AuthTokenTest
ChoiceAuthTest::testBadConfiguration() — Method in class ChoiceAuthTest

Test config validation

ChoiceAuthTest::testMissingPluginManager() — Method in class ChoiceAuthTest

Test default getPluginManager behavior

ChoiceAuthTest::testAuthenticate() — Method in class ChoiceAuthTest

Test successful login

ChoiceAuthTest::testAuthenticationFailure() — Method in class ChoiceAuthTest

Test authentication failure.

ChoiceAuthTest::testCreate() — Method in class ChoiceAuthTest

Test successful account creation

ChoiceAuthTest::testGetSelectableAuthOptions() — Method in class ChoiceAuthTest

Test getSelectableAuthOptions

ChoiceAuthTest::testLogout() — Method in class ChoiceAuthTest

Test logout

ChoiceAuthTest::testUpdatePassword() — Method in class ChoiceAuthTest

Test update password

ChoiceAuthTest::testIllegalMethod() — Method in class ChoiceAuthTest

Test an illegal auth method

ChoiceAuthTest::testContextFreeBehavior() — Method in class ChoiceAuthTest

Test that methods return false when no context is set.

DatabaseTest::testCreateIsAllowed() — Method in class DatabaseTest

Test account creation is allowed.

DatabaseTest::testCreationWithBlankUsername() — Method in class DatabaseTest

Test blank username.

DatabaseTest::testCreationWithBlankPassword() — Method in class DatabaseTest

Test blank password.

DatabaseTest::testCreationWithPasswordMismatch() — Method in class DatabaseTest

Test password mismatch.

DatabaseTest::testCreationWithInvalidEmail() — Method in class DatabaseTest

Test invalid email.

DatabaseTest::testSuccessfulCreation() — Method in class DatabaseTest

Test successful account creation.

DatabaseTest::testCreationWithDuplicateUsername() — Method in class DatabaseTest

Test duplicate username.

DatabaseTest::testCreationWithDuplicateEmail() — Method in class DatabaseTest

Test duplicate email.

DatabaseTest::testLoginWithBlankUsername() — Method in class DatabaseTest

Test login with blank username.

DatabaseTest::testLoginWithBlankPassword() — Method in class DatabaseTest

Test login with blank password.

DatabaseTest::testLoginWithUnrecognizedUsername() — Method in class DatabaseTest

Test login with unknown username.

DatabaseTest::testLoginWithBadPassword() — Method in class DatabaseTest

Test login with bad password.

DatabaseTest::testLogin() — Method in class DatabaseTest

Test successful login.

DatabaseTest::tearDownAfterClass() — Method in class DatabaseTest

Standard teardown method.

DatabaseUnitTest::testEmptyCreateRequest() — Method in class DatabaseUnitTest

Test validation of empty create request.

DatabaseUnitTest::testEmptyPasswordCreateRequest() — Method in class DatabaseUnitTest

Test validation of create request w/blank password.

DatabaseUnitTest::testMismatchedPasswordCreateRequest() — Method in class DatabaseUnitTest

Test validation of create request w/mismatched passwords.

DatabaseUnitTest::testCreateWithPasswordPolicy() — Method in class DatabaseUnitTest

Test validation of create request with a password policy.

DatabaseUnitTest::testCreateWithBadPasswordPolicyPattern() — Method in class DatabaseUnitTest

Test validation of create request with a password policy.

DatabaseUnitTest::testCreateWithUsernamePolicy() — Method in class DatabaseUnitTest

Test validation of create request with a username policy.

DatabaseUnitTest::testCreateWithMissingTableManager() — Method in class DatabaseUnitTest

Test missing table manager.

DatabaseUnitTest::testCreateDuplicateEmail() — Method in class DatabaseUnitTest

Test creation w/duplicate email.

DatabaseUnitTest::testCreateDuplicateUsername() — Method in class DatabaseUnitTest

Test creation w/duplicate username.

DatabaseUnitTest::testSuccessfulCreation() — Method in class DatabaseUnitTest

Test successful creation.

ILSAuthenticatorTest::testNewCatalogLoginSuccess() — Method in class ILSAuthenticatorTest

Test new catalog login success.

ILSAuthenticatorTest::testNewCatalogFailure() — Method in class ILSAuthenticatorTest

Test new catalog login failure.

ILSAuthenticatorTest::testNewCatalogFailureByException() — Method in class ILSAuthenticatorTest

Test new catalog login failure (caused by exception).

ILSAuthenticatorTest::testLoggedOutStoredLoginAttempt() — Method in class ILSAuthenticatorTest

Test stored catalog login attempt with logged out user.

ILSAuthenticatorTest::testSuccessfulStoredLoginAttempt() — Method in class ILSAuthenticatorTest

Test a successful stored login attempt.

ILSAuthenticatorTest::testUnsuccessfulStoredLoginAttempt() — Method in class ILSAuthenticatorTest

Test an unsuccessful stored login attempt.

ILSAuthenticatorTest::testExceptionDuringStoredLoginAttempt() — Method in class ILSAuthenticatorTest

Test an exception during stored login attempt.

ILSTest::testCreateIsDisallowed() — Method in class ILSTest

Test account creation is disallowed.

ILSTest::testLoginWithBlankUsername() — Method in class ILSTest

Test login with blank username.

ILSTest::testLoginWithBlankPassword() — Method in class ILSTest

Test login with blank password.

ILSTest::testBadLoginResponse() — Method in class ILSTest

Test login with technical error.

ILSTest::testLogin() — Method in class ILSTest

Test successful login.

ILSTest::testLoginWithMissingCatId() — Method in class ILSTest

Test failure caused by missing cat_id.

ILSTest::testUpdateUserPasswordWithEmptyValue() — Method in class ILSTest

Test updating a user's password with mismatched new password values.

ILSTest::testUpdateUserPasswordWithoutLoggedInUser() — Method in class ILSTest

Test updating a user's password with mismatched new password values.

ILSTest::testUpdateUserPasswordWithMismatch() — Method in class ILSTest

Test updating a user's password with mismatched new password values.

ILSTest::testUpdateUserPassword() — Method in class ILSTest

Test updating a user's password.

ILSTest::testUpdateUserPasswordUsingCatIdField() — Method in class ILSTest

Test updating a user's password (identifying user with cat_id field).

ILSTest::tearDownAfterClass() — Method in class ILSTest

Standard teardown method.

LDAPTest::testWithMissingHost() — Method in class LDAPTest

Verify that missing host causes failure.

LDAPTest::testWithMissingPort() — Method in class LDAPTest

Verify that missing port causes failure.

LDAPTest::testWithMissingBaseDN() — Method in class LDAPTest

Verify that missing baseDN causes failure.

LDAPTest::testWithMissingUid() — Method in class LDAPTest

Verify that missing UID causes failure.

LDAPTest::testCaseNormalization() — Method in class LDAPTest

Test case normalization of parameters.

LDAPTest::testCreateIsDisallowed() — Method in class LDAPTest

Test account creation is disallowed.

LDAPTest::testLoginWithBlankUsername() — Method in class LDAPTest

Test login with blank username.

LDAPTest::testLoginWithBlankPassword() — Method in class LDAPTest

Test login with blank password.

ManagerTest::testDefaultConfig() — Method in class ManagerTest

Test that database is the default method.

ManagerTest::testGetSessionInitiator() — Method in class ManagerTest

Test getSessionInitiator

ManagerTest::testGetSelectableAuthOptions() — Method in class ManagerTest

Test getSelectableAuthOptions

ManagerTest::testGetLoginTargets() — Method in class ManagerTest

Test getLoginTargets

ManagerTest::testGetDefaultLoginTarget() — Method in class ManagerTest

Test getDefaultLoginTarget

ManagerTest::testLogoutWithDestruction() — Method in class ManagerTest

Test logout (with destruction)

ManagerTest::testLogoutWithoutDestruction() — Method in class ManagerTest

Test logout (without destruction)

ManagerTest::testLoginEnabled() — Method in class ManagerTest

Test that login is enabled by default.

ManagerTest::testLoginDisabled() — Method in class ManagerTest

Test that login can be disabled by configuration.

ManagerTest::testSwitchingSuccess() — Method in class ManagerTest

Test security features of switching between auth options (part 1).

ManagerTest::testSwitchingFailure() — Method in class ManagerTest

Test security features of switching between auth options (part 2).

ManagerTest::testSupportsCreation() — Method in class ManagerTest

Test supportsCreation

ManagerTest::testSupportsRecovery() — Method in class ManagerTest

Test supportsRecovery

ManagerTest::testSupportsEmailChange() — Method in class ManagerTest

Test supportsEmailChange

ManagerTest::testSupportsPasswordChange() — Method in class ManagerTest

Test supportsPasswordChange

ManagerTest::testGetAuthClassForTemplateRendering() — Method in class ManagerTest

Test getAuthClassForTemplateRendering

ManagerTest::testUserHasLoggedOut() — Method in class ManagerTest

Test userHasLoggedOut

ManagerTest::testCreate() — Method in class ManagerTest

Test create

ManagerTest::testSuccessfulLogin() — Method in class ManagerTest

Test successful login

ManagerTest::testMissingCsrf() — Method in class ManagerTest

Test CSRF failure (same setup as successful login, but minus token)

ManagerTest::testIncorrectCsrf() — Method in class ManagerTest

Test CSRF failure (same setup as successful login, but with bad token)

ManagerTest::testPasswordSecurityException() — Method in class ManagerTest

Test unsuccessful login (\VuFind\Exception\PasswordSecurity)

ManagerTest::testAuthException() — Method in class ManagerTest

Test unsuccessful login (\VuFind\Exception\Auth)

ManagerTest::testUnanticipatedException() — Method in class ManagerTest

Test that unexpected exceptions get mapped to technical errors.

ManagerTest::testUpdatePassword() — Method in class ManagerTest

Test update password

ManagerTest::testCheckForExpiredCredentials() — Method in class ManagerTest

Test checkForExpiredCredentials

ManagerTest::testUserLoginFromSession() — Method in class ManagerTest

Test the persistence of a user account in the session.

ManagerTest::testAllowsUserIlsLoginDefault() — Method in class ManagerTest

Confirm default setting of allowsUserIlsLogin().

ManagerTest::testAllowsUserIlsLoginConfiguration() — Method in class ManagerTest

Confirm configurability of allowsUserIlsLogin().

MultiAuthTest::testWithMissingMethodOrder() — Method in class MultiAuthTest

Verify that missing host causes failure.

MultiAuthTest::testLoginWithBadService() — Method in class MultiAuthTest

Test login with handler configured to load a service which does not exist.

MultiAuthTest::testLoginWithBadClass() — Method in class MultiAuthTest

Test login with handler configured to load a class which does not conform to the appropriate authentication interface. (We'll use this test class as an arbitrary inappropriate class).

MultiAuthTest::testLoginWithBlankUsername() — Method in class MultiAuthTest

Test login with blank username.

MultiAuthTest::testLoginWithBlankPassword() — Method in class MultiAuthTest

Test login with blank password.

MultiILSTest::testCreateIsDisallowed() — Method in class MultiILSTest

Test account creation is disallowed.

MultiILSTest::testLoginWithEmptyTarget() — Method in class MultiILSTest

Test login with empty invalid target.

MultiILSTest::testLoginWithInvalidTarget() — Method in class MultiILSTest

Test login with invalid target.

MultiILSTest::testLoginWithBlankUsername() — Method in class MultiILSTest

Test login with blank username.

MultiILSTest::testLoginWithBlankPassword() — Method in class MultiILSTest

Test login with blank password.

MultiILSTest::testBadLoginResponse() — Method in class MultiILSTest

Test login with technical error.

MultiILSTest::testLogin() — Method in class MultiILSTest

Test successful login.

MultiILSTest::testLoginWithMissingCatId() — Method in class MultiILSTest

Test failure caused by missing cat_id.

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

SIP2Test::testLoginWithBlankUsername() — Method in class SIP2Test

Test login with blank username.

SIP2Test::testLoginWithBlankPassword() — Method in class SIP2Test

Test login with blank password.

ShibbolethTest::testCreateIsDisallowed() — Method in class ShibbolethTest

Test account creation is disallowed.

ShibbolethTest::testLoginWithBlankUsername() — Method in class ShibbolethTest

Test login with blank username.

ShibbolethTest::testLoginWithBlankPassword() — Method in class ShibbolethTest

Test login with blank username.

ShibbolethTest::testWithMissingAttributeValue() — Method in class ShibbolethTest

Test a configuration with a missing attribute value.

ShibbolethTest::testWithoutUsername() — Method in class ShibbolethTest

Test a configuration with missing username.

ShibbolethTest::testWithoutLoginSetting() — Method in class ShibbolethTest

Test a configuration with missing login setting.

ShibbolethTest::testSessionInitiator() — Method in class ShibbolethTest

Test session initiator

ShibbolethTest::testLogin() — Method in class ShibbolethTest

Test successful login.

ShibbolethTest::testLogin1() — Method in class ShibbolethTest

Test successful login.

ShibbolethTest::testLogin2() — Method in class ShibbolethTest

Test successful login.

ShibbolethTest::testFailedLogin() — Method in class ShibbolethTest

Test failed login.

ShibbolethTest::testProxyLogin() — Method in class ShibbolethTest

Test login using attributes passed in headers.

ShibbolethTest::tearDownAfterClass() — Method in class ShibbolethTest

Standard teardown method.

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

EdsTest::testGetSuggestions() — Method in class EdsTest

Test getSuggestions.

EdsTest::testGetSuggestionsWithNonDefaultConfiguration() — Method in class EdsTest

Test getSuggestions with non-default configuration.

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

SolrTest::testSetConfigDefaults() — Method in class SolrTest

Test that configuration is parsed correctly.

SolrTest::testSetConfig() — Method in class SolrTest

Test that configuration is parsed correctly.

TagTestClass in namespace VuFindTest\Autocomplete

Tag autocomplete test class.

TagTest::testMissingDependency() — Method in class TagTest

Test that missing plugin manager causes exception.

TagTest::testSuggestions() — Method in class TagTest

Test real suggestions.

AbstractHandlerMapTest::testPrepareDefaults() — Method in class AbstractHandlerMapTest

Test parameter preparation, defaults.

AbstractHandlerMapTest::testPrepareAppends() — Method in class AbstractHandlerMapTest

Test parameter preparation, appends.

AbstractHandlerMapTest::testPrepareInvariants() — Method in class AbstractHandlerMapTest

Test parameter preparation, invariants.

BackendTest::testSearch() — Method in class BackendTest

Test search.

BackendTest::testSearchLimit() — Method in class BackendTest

Test limits used for search requests

BackendTest::testNonDelimitedBlenderBackendFacet() — Method in class BackendTest

Test non-delimited blender_backend facet field.

BackendTest::testGetRecordCollectionFactory() — Method in class BackendTest

Test getRecordCollectionFactory.

BackendTest::testSearchPartialFailure() — Method in class BackendTest

Test search with a partial failure

BackendTest::testSearchTotalFailure() — Method in class BackendTest

Test search with a total failure

BackendTest::testSearchCollectionError() — Method in class BackendTest

Test search with a error returned in a collection

BackendTest::testArrayFacetFormat() — Method in class BackendTest

Test search with array facet format

BackendTest::testRetrieve() — Method in class BackendTest

Test retrieve.

BackendTest::testInvalidFilter() — Method in class BackendTest

Test invalid backend filter.

BackendTest::testInvalidAdaptiveBlockSize() — Method in class BackendTest

Test invalid adaptive block size configuration.

BackendTest::testEvents() — Method in class BackendTest

Test event handling

BackendTest::testEmptyCollectionArray() — Method in class BackendTest

Test initialization of an empty collection array

BackendTest::testRetrieve() — Method in class BackendTest

Test retrieving a record (not supported).

BackendTest::testSearch() — Method in class BackendTest

Test performing a search.

BackendTest::testSetQueryBuilder() — Method in class BackendTest

Test setting a query builder.

BackendTest::testDefaultQueryBuilder() — Method in class BackendTest

Test generation of a default query builder.

BackendTest::testConstructorSetters() — Method in class BackendTest

Test setting a custom record collection factory.

BackendTest::testDefaultRecordCollectionFactory() — Method in class BackendTest

Test construction of default record collection factory.

LookupDoiCommandTest::testSupportedBackend() — Method in class LookupDoiCommandTest

Test that a supported backend behaves as expected.

LookupIssnsCommandTest::testSupportedBackend() — Method in class LookupIssnsCommandTest

Test that a supported backend behaves as expected.

QueryBuilderTest::testBasic() — Method in class QueryBuilderTest

Test basic query parsing

QueryBuilderTest::testAdvanced() — Method in class QueryBuilderTest

Test advanced query parsing (not currently supported)

RecordCollectionFactoryTest::testFactory() — Method in class RecordCollectionFactoryTest

Test that the factory creates a collection.

RecordCollectionFactoryTest::testInvalidInput() — Method in class RecordCollectionFactoryTest

Test invalid input.

RecordCollectionTest::testDefaults() — Method in class RecordCollectionTest

Test defaults when given empty data.

RecordCollectionTest::testNonDefaults() — Method in class RecordCollectionTest

Test non-default values.

BackendTest::testAutocomplete() — Method in class BackendTest

Test performing an autocomplete

BackendTest::testRetrieve() — Method in class BackendTest

Test retrieving a record.

BackendTest::testSearch() — Method in class BackendTest

Test performing a search.

BackendTest::testSetQueryBuilder() — Method in class BackendTest

Test setting a query builder.

BackendTest::testConstructorSetters() — Method in class BackendTest

Test setting a custom record collection factory.

AutocompleteCommandTest::testCommand() — Method in class AutocompleteCommandTest

Test that the command works as expected

GetInfoCommandTest::testCommand() — Method in class GetInfoCommandTest

Test that the command works as expected

ConnectorTest::testCaching() — Method in class ConnectorTest

Test caching.

QueryBuilderTest::testBlankSearch() — Method in class QueryBuilderTest

Test special case for blank queries.

QueryBuilderTest::testParsing() — Method in class QueryBuilderTest

Test query parsing.

RecordCollectionFactoryTest::testConstructorRequiresFactoryFunction() — Method in class RecordCollectionFactoryTest

Test constructor exceptions.

RecordCollectionFactoryTest::testFactoryRequiresArray() — Method in class RecordCollectionFactoryTest

Test constructor exceptions.

RecordCollectionTest::testDefaults() — Method in class RecordCollectionTest

Test defaults when given empty data.

BackendTest::testRetrieve() — Method in class BackendTest

Test retrieving a record.

BackendTest::testSearch() — Method in class BackendTest

Test performing a search.

BackendTest::testSetQueryBuilder() — Method in class BackendTest

Test setting a query builder.

BackendTest::testDefaultQueryBuilder() — Method in class BackendTest

Test generation of a default query builder.

BackendTest::testConstructorSetters() — Method in class BackendTest

Test setting a custom record collection factory.

QueryBuilderTest::testParsing() — Method in class QueryBuilderTest

Test query parsing.

RecordCollectionFactoryTest::testConstructorRequiresValidFactoryFunction() — Method in class RecordCollectionFactoryTest

Test constructor exception.

RecordCollectionFactoryTest::testInvalidInput() — Method in class RecordCollectionFactoryTest

Test invalid input.

RecordCollectionTest::testDefaults() — Method in class RecordCollectionTest

Test defaults when given empty data.

RecordCollectionTest::testNonDefaults() — Method in class RecordCollectionTest

Test non-default values.

BackendTest::testRetrieve() — Method in class BackendTest

Test retrieving a record (not supported).

BackendTest::testSearch() — Method in class BackendTest

Test performing a search.

BackendTest::testSetQueryBuilder() — Method in class BackendTest

Test setting a query builder.

BackendTest::testDefaultQueryBuilder() — Method in class BackendTest

Test generation of a default query builder.

BackendTest::testConstructorSetters() — Method in class BackendTest

Test setting a custom record collection factory.

BackendTest::testDefaultRecordCollectionFactory() — Method in class BackendTest

Test construction of default record collection factory.

BackendTest::testSearchWrapsLibGuidesException() — Method in class BackendTest

Test search exception handling.

BackendTest::testMergedParamBag() — Method in class BackendTest

Test merged param bag.

BackendTest::testSearchFallback() — Method in class BackendTest

Test default search failover.

QueryBuilderTest::testBasic() — Method in class QueryBuilderTest

Test basic query parsing

QueryBuilderTest::testAdvanced() — Method in class QueryBuilderTest

Test advanced query parsing (not currently supported)

RecordCollectionFactoryTest::testFactory() — Method in class RecordCollectionFactoryTest

Test that the factory creates a collection.

RecordCollectionFactoryTest::testInvalidInput() — Method in class RecordCollectionFactoryTest

Test invalid input.

RecordCollectionTest::testDefaults() — Method in class RecordCollectionTest

Test defaults when given empty data.

RecordCollectionTest::testNonDefaults() — Method in class RecordCollectionTest

Test non-default values.

BackendTest::testGetConnector() — Method in class BackendTest

Test that getConnector works.

BackendTest::testSearch() — Method in class BackendTest

Test performing a search.

BackendTest::testSetSearchProgressTarget() — Method in class BackendTest

Test setter.

BackendTest::testSetMaxQueryTime() — Method in class BackendTest

Test setter.

BackendTest::testRetrieve() — Method in class BackendTest

Test retrieving a record.

BackendTest::testSearch() — Method in class BackendTest

Test performing a search.

BackendTest::testSetQueryBuilder() — Method in class BackendTest

Test setting a query builder.

BackendTest::testConstructorSetters() — Method in class BackendTest

Test setting a custom record collection factory.

BackendTest::testSearchWrapsPrimoException() — Method in class BackendTest

Test search exception handling.

BackendTest::testRetrieveWrapsPrimoException() — Method in class BackendTest

Test retrieve exception handling.

BackendTest::testMergedParamBag() — Method in class BackendTest

Test merged param bag.

BackendTest::testPcAvailabilityFilter() — Method in class BackendTest

Test pcAvailability filter.

ConnectorTest::testInstitutionCode() — Method in class ConnectorTest

Test default timeout value

ConnectorTest::testGetRecord() — Method in class ConnectorTest

Test a healthy call to getRecord.

ConnectorTest::testEmptyQueryError() — Method in class ConnectorTest

Test that an empty query causes an error.

ConnectorTest::testQuery() — Method in class ConnectorTest

Test a healthy call to query.

ConnectorTest::testDifferentlyNamespacedQuery() — Method in class ConnectorTest

Test a query response with non-standard namespacing.

ConnectorTest::testErrorInSuccessfulResponse() — Method in class ConnectorTest

Test a query response that contains an error message but has a successful HTTP status.

ConnectorTest::testCaching() — Method in class ConnectorTest

Test caching.

QueryBuilderTest::testBasic() — Method in class QueryBuilderTest

Test basic query parsing

QueryBuilderTest::testAdvanced() — Method in class QueryBuilderTest

Test advanced query parsing

RecordCollectionFactoryTest::testConstructorRequiresValidFactoryFunction() — Method in class RecordCollectionFactoryTest

Test constructor exception.

RecordCollectionFactoryTest::testInvalidInput() — Method in class RecordCollectionFactoryTest

Test invalid input.

RecordCollectionTest::testDefaults() — Method in class RecordCollectionTest

Test defaults when given empty data.

BackendTest::testRetrieve() — Method in class BackendTest

Test retrieving a record.

BackendTest::testRetrieveBatch() — Method in class BackendTest

Test retrieving a batch of records.

BackendTest::testRetrieveBatchWithNonDefaultPageSize() — Method in class BackendTest

Test retrieving a batch of records, using a non-default page size.

BackendTest::testSimilar() — Method in class BackendTest

Test retrieving similar records.

BackendTest::testTerms() — Method in class BackendTest

Test terms component.

BackendTest::testFacets() — Method in class BackendTest

Test facets.

BackendTest::testPivotFacets() — Method in class BackendTest

Test pivot facets.

BackendTest::testQueryFacets() — Method in class BackendTest

Test query facets.

BackendTest::testTermsWithParamBagAsFirstParameter() — Method in class BackendTest

Test terms component (using ParamBag as first param).

BackendTest::testBadJson() — Method in class BackendTest

Test handling of a bad JSON response.

BackendTest::testInjectResponseWriterThrownOnIncompabileResponseWriter() — Method in class BackendTest

Test injectResponseWriter throws on incompatible response writer.

BackendTest::testInjectResponseWriterThrownOnIncompabileNamedListSetting() — Method in class BackendTest

Test injectResponseWriter throws on incompatible named list setting.

BackendTest::testGetConnector() — Method in class BackendTest

Test getting a connector.

BackendTest::testGetIdentifier() — Method in class BackendTest

Test getting an identifier.

BackendTest::testGetIds() — Method in class BackendTest

Test getting multiple IDs.

BackendTest::testRefineAlphaBrowseException() — Method in class BackendTest

Test refining an alphabrowse exception (string 1).

BackendTest::testRefineAlphaBrowseExceptionWithAltString() — Method in class BackendTest

Test refining an alphabrowse exception (string 2).

BackendTest::testRefineAlphaBrowseExceptionWithNonBrowseString() — Method in class BackendTest

Test that we don't refine a non-alphabrowse-related exception.

BackendTest::testRandom() — Method in class BackendTest

Test random method

BackendTest::testWriteDocument() — Method in class BackendTest

Test writeDocument

RawJsonSearchCommandTest::testUnsupportedBackend() — Method in class RawJsonSearchCommandTest

Test that an error is thrown for unsupported backends.

RawJsonSearchCommandTest::testSupportedBackend() — Method in class RawJsonSearchCommandTest

Test that a supported backend behaves as expected.

WriteDocumentCommandTest::testUnsupportedBackend() — Method in class WriteDocumentCommandTest

Test that an error is thrown for unsupported backends.

WriteDocumentCommandTest::testSupportedBackend() — Method in class WriteDocumentCommandTest

Test that a supported backend behaves as expected.

ConnectorTest::testRetrieve() — Method in class ConnectorTest

Test record retrieval.

ConnectorTest::testRetrieveMissingRecord() — Method in class ConnectorTest

Test retrieving a non-existent record returns a response.

ConnectorTest::testInternalServerError() — Method in class ConnectorTest

Test RemoteErrorException is thrown on a remote 5xx error.

ConnectorTest::testBadRequestError() — Method in class ConnectorTest

Test RequestErrorException is thrown on a remote 4xx error.

ConnectorTest::testWriteCSV() — Method in class ConnectorTest

Test writing a CSV document.

ConnectorTest::testWriteJSON() — Method in class ConnectorTest

Test writing a JSON document.

ConnectorTest::testCaching() — Method in class ConnectorTest

Test caching.

ConnectorTest::testGetters() — Method in class ConnectorTest

Test simple getters.

ConnectorTest::testCallWithHttpOptions() — Method in class ConnectorTest

Test callWithHttpOptions.

ConnectorTest::testClientCreation() — Method in class ConnectorTest

Test that making a request calls the HTTP client factory

CommitDocumentTest::testAsXML() — Method in class CommitDocumentTest

Test creation of XML document.

DeleteDocumentTest::testAsXML() — Method in class DeleteDocumentTest

Test creation of XML document.

DeleteDocumentTest::testAsXMLMultiKey() — Method in class DeleteDocumentTest

Test creation of XML document with multiple keys.

OptimizeDocumentTest::testAsXML() — Method in class OptimizeDocumentTest

Test creation of XML document.

OptimizeDocumentTest::testAsXMLWithWaitSearcher() — Method in class OptimizeDocumentTest

Test creation of XML document with WaitSearcher.

RawCSVDocumentTest::testBasicBehavior() — Method in class RawCSVDocumentTest

Test creation of CSV document.

RawJSONDocumentTest::testBasicBehavior() — Method in class RawJSONDocumentTest

Test creation of JSON document.

RawXMLDocumentTest::testBasicBehavior() — Method in class RawXMLDocumentTest

Test creation of XML document.

UpdateDocumentTest::testAsXML() — Method in class UpdateDocumentTest

Test creation of XML document.

HandlerMapTest::testSetHandlerMapThrowsOnDuplicateFallback() — Method in class HandlerMapTest

Test exception on duplicate fallback handler.

HandlerMapTest::testSetHandlerMapThrowsOnDuplicateFunctionHandler() — Method in class HandlerMapTest

Test exception on duplicate handler.

HandlerMapTest::testGetHandlerThrowsOnUndefinedFunctionHandler() — Method in class HandlerMapTest

Test exception on undefined handler.

HandlerMapTest::testGetParametersThrowsOnUndefinedType() — Method in class HandlerMapTest

Test exception on unexpected type.

HandlerMapTest::testSetParametersThrowsOnUndefinedType() — Method in class HandlerMapTest

Test exception on unexpected type.

HandlerMapTest::testGetDefaultsAppendsInvariants() — Method in class HandlerMapTest

Test retrieve defaults, appends, invariants.

HandlerMapTest::testGetDefaultsAppendsInvariantsPureFallback() — Method in class HandlerMapTest

Test defaults, appends, invariants for pure fallback definitions.

HandlerMapTest::testAddParameter() — Method in class HandlerMapTest

Test addParameter

NamedListTest::testIterate() — Method in class NamedListTest

Test iterating over the list.

NamedListTest::testCountable() — Method in class NamedListTest

Test counting the list.

NamedListTest::testToArray() — Method in class NamedListTest

Test converting the list to an array.

NamedListTest::testKeyRemoval() — Method in class NamedListTest

Test key removal.

NamedListTest::testMultipleKeyRemoval() — Method in class NamedListTest

Test multiple key removal.

RecordCollectionFactoryTest::testFactory() — Method in class RecordCollectionFactoryTest

Test that the factory creates a collection.

RecordCollectionFactoryTest::testInvalidInput() — Method in class RecordCollectionFactoryTest

Test invalid input.

RecordCollectionTest::testDefaults() — Method in class RecordCollectionTest

Test that the object returns appropriate defaults for missing elements.

RecordCollectionTest::testDefaultsWithNullResponse() — Method in class RecordCollectionTest

Test that the object returns appropriate defaults when given a null response element.

RecordCollectionTest::testOffsets() — Method in class RecordCollectionTest

Test that the object handles offsets properly.

RecordCollectionTest::testSpellingQuery() — Method in class RecordCollectionTest

Test spelling query retrieval.

RecordCollectionTest::testSpellingSuggestions() — Method in class RecordCollectionTest

Test spelling suggestion retrieval.

RecordCollectionTest::testReplace() — Method in class RecordCollectionTest

Test the replace method.

RecordCollectionTest::testShuffle() — Method in class RecordCollectionTest

Test the shuffle method.

RecordCollectionTest::testAdd() — Method in class RecordCollectionTest

Test that the object handles offsets properly.

RecordCollectionTest::testFacets() — Method in class RecordCollectionTest

Test facet methods.

SpellcheckTest::testMerge() — Method in class SpellcheckTest

Test merge.

SpellcheckTest::testDoubleMerge() — Method in class SpellcheckTest

Test double merge.

SpellcheckTest::testExactDuplication() — Method in class SpellcheckTest

Test exact duplication.

SpellcheckTest::testGetQuery() — Method in class SpellcheckTest

Test getQuery()

TermsTestClass in namespace VuFindTest\Backend\Solr\Json\Response

Unit tests for terms information.

TermsTest::testTerms() — Method in class TermsTest

Test terms

LuceneSyntaxHelperTest::testCapitalizeBooleans() — Method in class LuceneSyntaxHelperTest

Test capitalizeBooleans functionality.

LuceneSyntaxHelperTest::testContainsBooleans() — Method in class LuceneSyntaxHelperTest

Test that booleans are detected properly.

LuceneSyntaxHelperTest::testSelectiveBooleanCapitalization() — Method in class LuceneSyntaxHelperTest

Test the selective capitalization functionality of capitalizeBooleans.

LuceneSyntaxHelperTest::testGetBoolsToCap() — Method in class LuceneSyntaxHelperTest

Test getBoolsToCap().

LuceneSyntaxHelperTest::testHasCaseSensitiveBooleans() — Method in class LuceneSyntaxHelperTest

Test hasCaseSensitiveBooleans().

LuceneSyntaxHelperTest::testCapitalizeRanges() — Method in class LuceneSyntaxHelperTest

Test capitalizeRanges functionality.

LuceneSyntaxHelperTest::testContainsAdvancedLuceneSyntaxWithDefaults() — Method in class LuceneSyntaxHelperTest

Test advanced query detection (default settings)

LuceneSyntaxHelperTest::testContainsAdvancedLuceneSyntaxWithCaseInsensitivity() — Method in class LuceneSyntaxHelperTest

Test advanced query detection (with case insensitivity)

LuceneSyntaxHelperTest::testCaseInsensitiveRangeNormalization() — Method in class LuceneSyntaxHelperTest

Test case insensitive range normalization

LuceneSyntaxHelperTest::testColonNormalization() — Method in class LuceneSyntaxHelperTest

Test colon normalization

LuceneSyntaxHelperTest::testExtractSearchTerms() — Method in class LuceneSyntaxHelperTest

Test search term extraction

LuceneSyntaxHelperTest::testUnquotedNormalization() — Method in class LuceneSyntaxHelperTest

Test normalization of unquoted special characters

QueryBuilderTest::testNormalization() — Method in class QueryBuilderTest

Test normalization of unusual queries.

QueryBuilderTest::testQueryHandler() — Method in class QueryBuilderTest

Test generation with a query handler

QueryBuilderTest::testQueryHandlerWithDismax() — Method in class QueryBuilderTest

Test generation with a query handler with regular dismax

QueryBuilderTest::testQueryHandlerWithEdismax() — Method in class QueryBuilderTest

Test generation with a query handler with edismax

QueryBuilderTest::testExactQueryHandler() — Method in class QueryBuilderTest

Test that the appropriate handler gets called for a quoted search when exact settings are enabled.

QueryBuilderTest::testQueryHandlerWithFilterQueryAndDisMax() — Method in class QueryBuilderTest

Test generation with a query handler with a filter set and DisMax settings

QueryBuilderTest::testQueryHandlerWithFilterQueryAndNoDisMax() — Method in class QueryBuilderTest

Test generation with a query handler with a filter set and no DisMax settings

QueryBuilderTest::testMatchAllQueryWithFilterQueryAndNoDisMax() — Method in class QueryBuilderTest

Test generation with a query handler with a filter set and no DisMax settings when the query is "all records"

QueryBuilderTest::testHlQ() — Method in class QueryBuilderTest

Test hl.q edge case: when we are in dismax (not edismax) mode, and a boost is set, and a query contains advanced syntax, VuFind manipulates the query to trigger the boost and sets hl.q to prevent the highlighter from matching the wrong words.

QueryBuilderTest::testSetFieldsToHighlight() — Method in class QueryBuilderTest

Test generation with highlighting, using the setFieldsToHighlight() method.

QueryBuilderTest::testSetCreateSpellingQuery() — Method in class QueryBuilderTest

Test generation with spelling, using the setCreateSpellingQuery() method.

QueryBuilderTest::testQueryGroup() — Method in class QueryBuilderTest

Test generation from a QueryGroup

QueryBuilderTest::testQueryGroupWithAdvancedSyntax() — Method in class QueryBuilderTest

Test generation from a QueryGroup with advanced syntax

QueryBuilderTest::testMultipleQuotedPhrases() — Method in class QueryBuilderTest

Test generation with multiple quoted phrases.

QueryBuilderTest::testMixedQuotedPhrases() — Method in class QueryBuilderTest

Test generation with mix of quoted and unquoted phrases

QueryBuilderTest::testMixedQuotedPhrasesWithEscapedQuote() — Method in class QueryBuilderTest

Test generation with mix of quoted and unquoted phrases

QueryBuilderTest::testIndividualQueryHandlerWithGlobalExtraParams() — Method in class QueryBuilderTest

Test generation with GlobalExtraParams using individual queries.

QueryBuilderTest::testGroupedQueryHandlerWithGlobalExtraParams() — Method in class QueryBuilderTest

Test generation with GlobalExtraParams using a grouped query.

QueryBuilderTest::testNegatedQuery() — Method in class QueryBuilderTest

Test a fully negated query.

QueryBuilderTest::testNegatedAndQuery() — Method in class QueryBuilderTest

Test a negated clause of an AND query.

QueryBuilderTest::testNegatedOrQuery() — Method in class QueryBuilderTest

Test a negated clause of an OR query.

SerializableRecordTest::testGetFields() — Method in class SerializableRecordTest

Test field retrieval

SearchHandlerTest::testSimpleSearchDismax() — Method in class SearchHandlerTest

Test creating simple dismax query.

SearchHandlerTest::testSimpleStandardSearch() — Method in class SearchHandlerTest

Test creating simple standard query.

SearchHandlerTest::testToArray() — Method in class SearchHandlerTest

Test toArray() method.

SearchHandlerTest::testSimpleSearchExtendedDismax() — Method in class SearchHandlerTest

Test creating extended dismax query.

SearchHandlerTest::testCustomMunge() — Method in class SearchHandlerTest

Test custom munge rules.

SearchHandlerTest::testPreprocessQueryString() — Method in class SearchHandlerTest

Test dismax munge rules.

SimilarBuilderTest::testDefaultParams() — Method in class SimilarBuilderTest

Test builder with default params.

SimilarBuilderTest::testAlternativeIdField() — Method in class SimilarBuilderTest

Test builder with alternative id field.

SimilarBuilderTest::testMltConfig() — Method in class SimilarBuilderTest

Test builder with different configurations.

QueryBuilderTest::testParsing() — Method in class QueryBuilderTest

Test query parsing.

RecordCollectionFactoryTest::testConstructorRequiresFactoryFunction() — Method in class RecordCollectionFactoryTest

Test constructor exceptions.

RecordCollectionFactoryTest::testFactoryRequiresArray() — Method in class RecordCollectionFactoryTest

Test constructor exceptions.

RecordCollectionTest::testDefaults() — Method in class RecordCollectionTest

Test defaults when given empty data.

BackendTest::testRetrieve() — Method in class BackendTest

Test retrieving a record.

BackendTest::testSearch() — Method in class BackendTest

Test performing a search.

BackendTest::testSetQueryBuilder() — Method in class BackendTest

Test setting a query builder.

BackendTest::testConstructorSetters() — Method in class BackendTest

Test setting a custom record collection factory.

GetHoldingsCommandTest::testUnsupportedBackend() — Method in class GetHoldingsCommandTest

Test that an error is thrown for unsupported backends.

GetHoldingsCommandTest::testSupportedBackend() — Method in class GetHoldingsCommandTest

Test that a supported backend behaves as expected.

ConnectorTest::testGetHoldings() — Method in class ConnectorTest

Test "get holdings"

ConnectorTest::testGetHoldingsHttpFailure() — Method in class ConnectorTest

Test "get holdings" HTTP failure

ConnectorTest::testGetRecord() — Method in class ConnectorTest

Test "get record"

ConnectorTest::testGetRecordWithError() — Method in class ConnectorTest

Test "get record" with error

ConnectorTest::testSearch() — Method in class ConnectorTest

Test search

QueryBuilderTest::testParsing() — Method in class QueryBuilderTest

Test query parsing.

QueryBuilderTest::testExclude() — Method in class QueryBuilderTest

Test the "exclude code" feature.

RecordCollectionFactoryTest::testBadCallback() — Method in class RecordCollectionFactoryTest

Test bad callback.

RecordCollectionFactoryTest::testBadFactoryInput() — Method in class RecordCollectionFactoryTest

Test bad factory input.

ScopusTest::testNameSplittingDefaultBehavior() — Method in class ScopusTest

Test name splitting (default behavior).

ScopusTest::testNameSplittingWithHyphenatedInitials() — Method in class ScopusTest

Test name splitting with hyphenated initials in the list.

ScopusTest::testNameSplittingWithMissingInitials() — Method in class ScopusTest

Test name splitting with a one-part name in the list.

ScopusTest::testNameSplittingWithFirstOnlyFlag() — Method in class ScopusTest

Test name splitting (with "first only" flag).

ImporterConfigTest::testConstructorOptions() — Method in class ImporterConfigTest

Test that options sent to the constructor are respected.

ImporterConfigTest::testConstructorDefaults() — Method in class ImporterConfigTest

Test that defaults are set if no options are provided to constructor.

ImporterConfigTest::testColumnConfigurationMerging() — Method in class ImporterConfigTest

Test column configuration merging behavior.

ImporterConfigTest::testFieldConfigurationMerging() — Method in class ImporterConfigTest

Test field configuration merging behavior.

ImporterConfigTest::testColumnFieldConfiguration() — Method in class ImporterConfigTest

Confirm that adding a column to field mapping adds the field to the field list.

ImporterConfigTest::testGetFixedFieldValues() — Method in class ImporterConfigTest

Test retrieval of hard-coded field values.

ImporterConfigTest::testGetOutstandingCallbacks() — Method in class ImporterConfigTest

Test getOutstandingCallbacks.

ImporterTest::testImportInTestMode() — Method in class ImporterTest

Test importer functionality (in test mode).

ImporterTest::testSkipHeader() — Method in class ImporterTest

Test skipping the header row in the CSV

ImporterTest::testNoHeader() — Method in class ImporterTest

Test importing a CSV with no header row.

ImporterTest::testAdvancedCallbacks() — Method in class ImporterTest

Test importing a CSV with extra callbacks using advanced features

ImporterTest::testImportIsoEncoding() — Method in class ImporterTest

Test importer functionality with non-default ISO-8859-1 encoding (in test mode).

ImporterTest::testMultilineValues() — Method in class ImporterTest

Test importer functionality with multiline CSV values (in test mode).

ImporterTest::testEncodingMismatch() — Method in class ImporterTest

Test behavior when the actual encoding and configured encoding are mismatched.

ImporterTest::testImportInLiveMode() — Method in class ImporterTest

Test importer functionality (in non-test mode).

ImporterTest::testImportInSmallBatches() — Method in class ImporterTest

Test importer functionality (with small batch size set).

ImageFactoryTest::testFactory() — Method in class ImageFactoryTest

Test that the factory behaves correctly.

IntervalTest::testIntervalCaptcha() — Method in class IntervalTest

Test Interval captchs

CartTest::testCookieDomain() — Method in class CartTest

Test cookie domain setting.

CartTest::testEmptyCart() — Method in class CartTest

Check that the cart is empty by default.

CartTest::testMaxSize() — Method in class CartTest

Check that the cart correctly registers a maximum size.

CartTest::testFullCart() — Method in class CartTest

Test that the cart can fill up.

CartTest::testActiveCart() — Method in class CartTest

Test an active cart.

CartTest::testDisabledCart() — Method in class CartTest

Test a disabled cart.

CartTest::testCookieWrite() — Method in class CartTest

Test that the save method writes the expected cookies.

CartTest::testContains() — Method in class CartTest

Test the contains method.

CartTest::testCartCanBeEmptied() — Method in class CartTest

Test the "empty cart" method.

CartTest::testRemoveItems() — Method in class CartTest

Test the "remove items" method.

CartTest::testGetRecordDetails() — Method in class CartTest

Test the "get record details" method.

CartTest::testVF1Cookie() — Method in class CartTest

Test loading values from a VuFind 1.x-style cookie.

CartTest::testVF2Cookie() — Method in class CartTest

Test loading values from a VuFind 2.x-style cookie.

AlphaBrowseTest::testGetFromRecord() — Method in class AlphaBrowseTest

Test deriving channel information from a record driver object.

AlphaBrowseTest::testGetFromRecordWhenChannelTokenIsSet() — Method in class AlphaBrowseTest

Test deriving channel information from a record driver object when we have a token that does not match record driver.

AlphaBrowseTest::testGetFromSearch() — Method in class AlphaBrowseTest

Test deriving channel information from a search results object.

AlphaBrowseTest::testGetFromSearchWhenMaxRecordsIsLessthanChannels() — Method in class AlphaBrowseTest

Test deriving channel information from a search results object when maxRecordsToExamine is lessthan channels.

AlphaBrowseTest::testGetFromSearchWhenChannelsIsEmpty() — Method in class AlphaBrowseTest

Test deriving channel information from a search results object with a specific single channel to load.

RandomTest::testGetFromRecord() — Method in class RandomTest

Test deriving channel information from a record driver object.

RandomTest::testGetFromSearch() — Method in class RandomTest

Test deriving channel information from a search results object.

SimilarItemsTest::testGetFromRecord() — Method in class SimilarItemsTest

Test deriving channel information from a record driver object.

SimilarItemsTest::testGetFromRecordWhenChannelTokenIsSet() — Method in class SimilarItemsTest

Test deriving channel information from a record driver object when we have a token that do not match record driver.

SimilarItemsTest::testGetFromSearch() — Method in class SimilarItemsTest

Test deriving channel information from a search results object.

SimilarItemsTest::testGetFromSearchWhenMaxRecordsIsLessthanChannels() — Method in class SimilarItemsTest

Test deriving channel information from a search results object when maxRecordsToExamine is lessthan channels.

SimilarItemsTest::testGetFromSearchWhenChannelsIsEmpty() — Method in class SimilarItemsTest

Test deriving channel information from a search results object with a specific single channel to load.

AlphabeticBrowseCommandTest::testCommand() — Method in class AlphabeticBrowseCommandTest

Test that the command works as expected

ThemeCommandTestClass in namespace VuFindTest\Command\Compile

Compile/Theme command test.

ThemeCommandTest::testWithoutParameters() — Method in class ThemeCommandTest

Test that missing parameters yield an error message.

ThemeCommandTest::testSuccessWithMinimalParameters() — Method in class ThemeCommandTest

Test the simplest possible success case.

ThemeCommandTest::testFailureWithMissingForce() — Method in class ThemeCommandTest

Simulate failure caused by existing theme and no '--force' option.

ThemeCommandTest::testSuccessWithForceOption() — Method in class ThemeCommandTest

Simulate success with '--force' option.

DynamicRouteCommandTest::testWithoutParameters() — Method in class DynamicRouteCommandTest

Test that missing parameters yield an error message.

DynamicRouteCommandTest::testSuccessWithMinimalParameters() — Method in class DynamicRouteCommandTest

Test the simplest possible success case.

ExtendClassCommandTest::testWithoutParameters() — Method in class ExtendClassCommandTest

Test that missing parameters yield an error message.

ExtendClassCommandTest::testSuccessWithMinimalParameters() — Method in class ExtendClassCommandTest

Test the simplest possible success case.

ExtendClassCommandTest::testSuccessWithFactoryOption() — Method in class ExtendClassCommandTest

Test the extendfactory option.

ExtendClassCommandTest::testError() — Method in class ExtendClassCommandTest

Test exception handling.

ExtendServiceCommandTest::testWithoutParameters() — Method in class ExtendServiceCommandTest

Test that missing parameters yield an error message.

ExtendServiceCommandTest::testSuccessWithMinimalParameters() — Method in class ExtendServiceCommandTest

Test the simplest possible success case.

ExtendServiceCommandTest::testError() — Method in class ExtendServiceCommandTest

Test exception handling.

NonTabRecordActionCommandTest::testWithoutParameters() — Method in class NonTabRecordActionCommandTest

Test that missing parameters yield an error message.

NonTabRecordActionCommandTest::testSuccessWithMinimalParameters() — Method in class NonTabRecordActionCommandTest

Test the simplest possible success case.

PluginCommandTest::testWithoutParameters() — Method in class PluginCommandTest

Test that missing parameters yield an error message.

PluginCommandTest::testSuccessWithMinimalParameters() — Method in class PluginCommandTest

Test the simplest possible success case.

PluginCommandTest::testSuccessWithFactoryParameter() — Method in class PluginCommandTest

Test the factory parameter.

PluginCommandTest::testError() — Method in class PluginCommandTest

Test exception handling.

RecordRouteCommandTest::testWithoutParameters() — Method in class RecordRouteCommandTest

Test that missing parameters yield an error message.

RecordRouteCommandTest::testSuccessWithMinimalParameters() — Method in class RecordRouteCommandTest

Test the simplest possible success case.

StaticRouteCommandTest::testWithoutParameters() — Method in class StaticRouteCommandTest

Test that missing parameters yield an error message.

StaticRouteCommandTest::testSuccessWithMinimalParameters() — Method in class StaticRouteCommandTest

Test the simplest possible success case.

ThemeCommandTestClass in namespace VuFindTest\Command\Generate

Generate/Theme command test.

ThemeCommandTest::testSuccessWithMinimalParameters() — Method in class ThemeCommandTest

Test the simplest possible success case.

ThemeCommandTest::testFailure() — Method in class ThemeCommandTest

Test a failure scenario.

ThemeMixinCommandTestClass in namespace VuFindTest\Command\Generate

Generate/ThemeMixin command test.

ThemeMixinCommandTest::testSuccessWithMinimalParameters() — Method in class ThemeMixinCommandTest

Test the simplest possible success case.

ThemeMixinCommandTest::testFailure() — Method in class ThemeMixinCommandTest

Test a failure scenario.

GetIdsCommandTest::testGetIdsInterface() — Method in class GetIdsCommandTest

Test GetIds with GetIdsInterface

GetIdsCommandTest::testGetIdsNoInterface() — Method in class GetIdsCommandTest

Test GetIds without GetIdsInterface

GetIdsCommandTest::testgetArguments() — Method in class GetIdsCommandTest

Test getArguments method

GetLuceneHelperCommandTest::testUnsupportedBackend() — Method in class GetLuceneHelperCommandTest

Test that an error is thrown for unsupported backends.

GetLuceneHelperCommandTest::testMismatchedBackendId() — Method in class GetLuceneHelperCommandTest

Test that an error is thrown for mismatched backend IDs.

GetLuceneHelperCommandTest::testSupportedBackend() — Method in class GetLuceneHelperCommandTest

Test that a supported backend behaves as expected.

GetQueryBuilderCommandTest::testMismatchedBackendId() — Method in class GetQueryBuilderCommandTest

Test that an error is thrown for mismatched backend IDs.

GetQueryBuilderCommandTest::testSupportedBackend() — Method in class GetQueryBuilderCommandTest

Test that a supported backend behaves as expected.

GetUniqueKeyCommandTest::testUnsupportedBackend() — Method in class GetUniqueKeyCommandTest

Test that an error is thrown for unsupported backends.

GetUniqueKeyCommandTest::testMismatchedBackendId() — Method in class GetUniqueKeyCommandTest

Test that an error is thrown for mismatched backend IDs.

GetUniqueKeyCommandTest::testSupportedBackend() — Method in class GetUniqueKeyCommandTest

Test that a supported backend behaves as expected.

HarvestOaiCommandTest::testIniOverride() — Method in class HarvestOaiCommandTest

Test that the --ini setting is overridden automatically.

MergeMarcCommandTest::testWithoutParameters() — Method in class MergeMarcCommandTest

Test that missing parameters yield an error message.

MergeMarcCommandTest::testMergingDirectory() — Method in class MergeMarcCommandTest

Test that merging a directory yields valid results.

MergeMarcCommandTest::testMissingDirectory() — Method in class MergeMarcCommandTest

Test that merging a non-existent directory yields an error message.

ImportCsvCommandTest::testWithoutParameters() — Method in class ImportCsvCommandTest

Test that missing parameters yield an error message.

ImportCsvCommandTest::testSuccessWithMinimalParameters() — Method in class ImportCsvCommandTest

Test the simplest possible success case.

ImportCsvCommandTest::testFailure() — Method in class ImportCsvCommandTest

Test a failure scenario

ImportXslCommandTest::testWithoutParameters() — Method in class ImportXslCommandTest

Test that missing parameters yield an error message.

ImportXslCommandTest::testSuccessWithMinimalParameters() — Method in class ImportXslCommandTest

Test the simplest possible success case.

ImportXslCommandTest::testFailure() — Method in class ImportXslCommandTest

Test a failure scenario

InstallCommandTest::testInteractiveInstallation() — Method in class InstallCommandTest

Test the interactive installation process.

InstallCommandTest::testNonInteractiveInstallation() — Method in class InstallCommandTest

Test the non-interactive installation process.

WebCrawlCommandTest::testSuccessWithMinimalParameters() — Method in class WebCrawlCommandTest

Test the simplest possible success case.

AddUsingTemplateCommandTest::testWithoutParameters() — Method in class AddUsingTemplateCommandTest

Test that missing parameters yield an error message.

AddUsingTemplateCommandTest::testSuccessWithMinimalParameters() — Method in class AddUsingTemplateCommandTest

Test the simplest possible success case.

CopyStringCommandTest::testWithoutParameters() — Method in class CopyStringCommandTest

Test that missing parameters yield an error message.

CopyStringCommandTest::testSuccessWithMinimalParameters() — Method in class CopyStringCommandTest

Test the simplest possible success case.

CopyStringCommandTest::testSuccessWithReplaceOptionAndDefaultDelimiter() — Method in class CopyStringCommandTest

Test success with the replace option set.

CopyStringCommandTest::testSuccessWithReplaceOptionAndCustomDelimiter() — Method in class CopyStringCommandTest

Test success with the replace and replaceDelimiter options set.

CopyStringCommandTest::testFailureWithMissingTextDomain() — Method in class CopyStringCommandTest

Test failure due to missing text domain.

DeleteCommandTest::testWithoutParameters() — Method in class DeleteCommandTest

Test that missing parameters yield an error message.

DeleteCommandTest::testSuccessWithMinimalParameters() — Method in class DeleteCommandTest

Test the simplest possible success case.

DeleteCommandTest::testDeletingNonExistentString() — Method in class DeleteCommandTest

Test an attempt to delete a string that does not exist.

NormalizeCommandTest::testWithoutParameters() — Method in class NormalizeCommandTest

Test that missing parameters yield an error message.

NormalizeCommandTest::testNormalizingDirectory() — Method in class NormalizeCommandTest

Test normalizing a directory.

NormalizeCommandTest::testNormalizingDirectoryWithBadFilter() — Method in class NormalizeCommandTest

Test normalizing a directory.

NormalizeCommandTest::testNormalizingFile() — Method in class NormalizeCommandTest

Test normalizing a file.

NormalizeCommandTest::testNormalizingNonExistentFile() — Method in class NormalizeCommandTest

Test an attempt to normalize a file that does not exist.

NormalizeCommandTest::testNormalizingNonLanguageFile() — Method in class NormalizeCommandTest

Test an attempt to normalize a file that contains bad content.

RandomCommandTest::testRandomInterface() — Method in class RandomCommandTest

Test Random with RandomInterface

RandomCommandTest::testRandomNoInterfaceWithNoResults() — Method in class RandomCommandTest

Test Random (without RandomInterface)

RandomCommandTest::testRandomNoInterfaceWithResultsLessThanLimit() — Method in class RandomCommandTest

Test Random (without RandomInterface)

RandomCommandTest::testRandomNoInterfaceWithResultsGreaterThanLimit() — Method in class RandomCommandTest

Test Random (without RandomInterface)

RandomCommandTest::testgetArguments() — Method in class RandomCommandTest

Test getting arguments

RetrieveBatchCommandTest::testExecute() — Method in class RetrieveBatchCommandTest

Test RetrieveBatch with RetrieveBatchInterface

RetrieveBatchCommandTest::testExecuteWithoutRetrieveBatchInterface() — Method in class RetrieveBatchCommandTest

Test RetrieveBatch without RetrieveBatchInterface

RetrieveBatchCommandTest::testgetArguments() — Method in class RetrieveBatchCommandTest

Test getArguments method

RetrieveBatchCommandTest::testgetRecordIdentifiers() — Method in class RetrieveBatchCommandTest

Test getRecordIdentifiers method

RetrieveCommandTest::testExecute() — Method in class RetrieveCommandTest

Test that a supported backed behaves as expected

RetrieveCommandTest::testgetArguments() — Method in class RetrieveCommandTest

Test getArguments method

NotifyCommandTest::testNoNotifications() — Method in class NotifyCommandTest

Test behavior when no notifications are waiting to be sent.

NotifyCommandTest::testNotificationWithIllegalFrequency() — Method in class NotifyCommandTest

Test behavior when notifications are waiting to be sent but there is no matching frequency configuration.

NotifyCommandTest::testNotificationWithRecentExecution() — Method in class NotifyCommandTest

Test behavior when notifications have already been sent recently.

NotifyCommandTest::testNotificationsWithMissingUser() — Method in class NotifyCommandTest

Test behavior when notifications are waiting to be sent but user does not exist.

NotifyCommandTest::testNotificationsWithUnsupportedBackend() — Method in class NotifyCommandTest

Test behavior when notifications are waiting to be sent but an illegal backend is involved.

NotifyCommandTest::testNotificationsWithNoSearchResults() — Method in class NotifyCommandTest

Test behavior when notifications are waiting to be sent but no search results exist.

NotifyCommandTest::testNotificationsWithNoNewSearchResults() — Method in class NotifyCommandTest

Test behavior when notifications are waiting to be sent but no search results exist.

NotifyCommandTest::testNotificationsWithNewSearchResults() — Method in class NotifyCommandTest

Test behavior when notifications are waiting to be sent and new search results exist.

SearchCommandTest::testCommand() — Method in class SearchCommandTest

Test that the command works as expected

SearchCommandTest::testSearchQuery() — Method in class SearchCommandTest

Test setter and getter of Search query.

SearchCommandTest::testSearchOffset() — Method in class SearchCommandTest

Test setter and getter of Search offset.

SearchCommandTest::testSearchLimit() — Method in class SearchCommandTest

Test setter and getter of Search limit.

SearchCommandTest::testSearchParameters() — Method in class SearchCommandTest

Test setter and getter of Search Parameters.

SearchCommandTest::testCommandContext() — Method in class SearchCommandTest

Test setter and getter of command context.

SearchCommandTest::testTargetBackendIdentifier() — Method in class SearchCommandTest

Test setter and getter of target backend identifier.

SearchCommandTest::testTooEarlyResults() — Method in class SearchCommandTest

Test that the command throws an exception results are requested before execute

SetRecordCollectionFactoryCommandTest::testCommand() — Method in class SetRecordCollectionFactoryCommandTest

Test that the command works as expected

SetRecordCollectionFactoryCommandTest::testgetArguments() — Method in class SetRecordCollectionFactoryCommandTest

Test getArguments method.

SimilarCommandTest::testCommand() — Method in class SimilarCommandTest

Test that the command works as expected

SimilarCommandTest::testSearchParameters() — Method in class SimilarCommandTest

Test setter and getter of Search Parameters.

SimilarCommandTest::testTargetBackendIdentifier() — Method in class SimilarCommandTest

Test setter and getter of target backend identifier.

SimilarCommandTest::testCommandContext() — Method in class SimilarCommandTest

Test setter and getter of command context.

SimilarCommandTest::testTooEarlyResults() — Method in class SimilarCommandTest

Test that the command throws an exception results are requested before execute

SimilarCommandTest::testgetArguments() — Method in class SimilarCommandTest

Test for getArguments method

TermsCommandTestClass in namespace VuFindTest\Command

Unit tests for TermsCommand.

TermsCommandTest::testCommand() — Method in class TermsCommandTest

Test that the command works as expected

TermsCommandTest::testUnsupportedBackend() — Method in class TermsCommandTest

Test that the command throws an appropriate exception for an unsupported backend.

$ AbstractExpireCommandTest#targetClassProperty in class AbstractExpireCommandTest

Name of class being tested

AbstractExpireCommandTest::testUnsupportedTableClass() — Method in class AbstractExpireCommandTest

Test an unsupported table class.

AbstractExpireCommandTest::testIllegalAgeInput() — Method in class AbstractExpireCommandTest

Test an illegal age parameter.

AbstractExpireCommandTest::testSuccessfulExpiration() — Method in class AbstractExpireCommandTest

Test that the command expires rows correctly.

AbstractExpireCommandTest::testSuccessfulNonExpiration() — Method in class AbstractExpireCommandTest

Test correct behavior when no rows need to be expired.

CleanUpRecordCacheCommandTest::testBasicOperation() — Method in class CleanUpRecordCacheCommandTest

Test that the cache clear action is delegated properly.

CommitCommandTest::testSuccessWithOptions() — Method in class CommitCommandTest

Test success with all options set.

CreateHierarchyTreesCommandTest::testSkippingEverything() — Method in class CreateHierarchyTreesCommandTest

Test skipping everything.

CreateHierarchyTreesCommandTest::testPopulatingEverything() — Method in class CreateHierarchyTreesCommandTest

Test populating everything.

DedupeCommandTest::testWithMissingFile() — Method in class DedupeCommandTest

Test that missing file yields an error message.

DedupeCommandTest::testSuccessWithArguments() — Method in class DedupeCommandTest

Test success with command line arguments.

DedupeCommandTest::testSuccessWithoutArguments() — Method in class DedupeCommandTest

Test success with interactive input.

DeletesCommandTest::testWithoutParameters() — Method in class DeletesCommandTest

Test that missing parameters yield an error message.

DeletesCommandTest::testWithMissingFile() — Method in class DeletesCommandTest

Test that missing file yields an error message.

DeletesCommandTest::testSuccessWithFlatFileAndDefaultIndex() — Method in class DeletesCommandTest

Test success with a flat file and default index.

DeletesCommandTest::testSuccessWithMarcFileAndNonDefaultIndex() — Method in class DeletesCommandTest

Test success with a MARC file and non-default index.

$ ExpireAuthHashesCommandTest#targetClassProperty in class ExpireAuthHashesCommandTest

Name of class being tested

$ ExpireExternalSessionsCommandTest#targetClassProperty in class ExpireExternalSessionsCommandTest

Name of class being tested

$ ExpireSearchesCommandTest#targetClassProperty in class ExpireSearchesCommandTest

Name of class being tested

$ ExpireSessionsCommandTest#targetClassProperty in class ExpireSessionsCommandTest

Name of class being tested

IndexReservesCommandTest::testBadParameterCombination() — Method in class IndexReservesCommandTest

Test bad parameter combination.

IndexReservesCommandTest::testBadFilename() — Method in class IndexReservesCommandTest

Test missing file.

IndexReservesCommandTest::testSuccessWithMultipleFiles() — Method in class IndexReservesCommandTest

Test successful file loading.

IndexReservesCommandTest::testMissingData() — Method in class IndexReservesCommandTest

Test unsuccessful ILS loading (missing data elements).

IndexReservesCommandTest::testSuccessWithILS() — Method in class IndexReservesCommandTest

Test successful ILS loading.

LintMarcCommandTest::testWithoutParameters() — Method in class LintMarcCommandTest

Test that missing parameters yield an error message.

LintMarcCommandTest::testLintingFile() — Method in class LintMarcCommandTest

Test that linting a file yields useful messages.

OptimizeCommandTest::testSuccessWithOptions() — Method in class OptimizeCommandTest

Test success with all options set.

ScssBuilderCommandTest::testBasicOperation() — Method in class ScssBuilderCommandTest

Test that the command delegates proper behavior.

SitemapCommandTest::testSuccessWithOptions() — Method in class SitemapCommandTest

Test success with all options set.

SuppressedCommandTest::testNoRecordsToDelete() — Method in class SuppressedCommandTest

Test no results coming back from ILS

SuppressedCommandTest::testRecordsToDelete() — Method in class SuppressedCommandTest

Test successful Solr update.

SuppressedCommandTest::testNoAuthorityRecordsToDelete() — Method in class SuppressedCommandTest

Test no results coming back from ILS

SuppressedCommandTest::testWriteToFile() — Method in class SuppressedCommandTest

Test write to file.

SuppressedCommandTest::testFailedWriteToFile() — Method in class SuppressedCommandTest

Test failed write to file.

SwitchDbHashCommandTest::testWithoutParameters() — Method in class SwitchDbHashCommandTest

Test that missing parameters yield an error message.

SwitchDbHashCommandTest::testWithoutKeyParameter() — Method in class SwitchDbHashCommandTest

Test missing key parameter (not in config or on command line).

SwitchDbHashCommandTest::testNoActionNeeded() — Method in class SwitchDbHashCommandTest

Test no action needed because no changes requested.

SwitchDbHashCommandTest::testFailedConfigWrite() — Method in class SwitchDbHashCommandTest

Test failed configurate write.

SwitchDbHashCommandTest::testSuccessNoUsers() — Method in class SwitchDbHashCommandTest

Test success with no users to update.

SwitchDbHashCommandTest::testSuccessWithUser() — Method in class SwitchDbHashCommandTest

Test success with a user to update.

WorkExpressionsCommandTest::testBasicUsageOfCommand() — Method in class WorkExpressionsCommandTest

Test that the command works as expected with both parameters provided

WorkExpressionsCommandTest::testWorkKeyAutofill() — Method in class WorkExpressionsCommandTest

Test that the command looks up work keys if they are omitted

LocatorTest::testLocator() — Method in class LocatorTest

Test Locator

PathResolverTest::testPathResolver() — Method in class PathResolverTest

Test PathResolver

PathResolverTest::testPathStack() — Method in class PathResolverTest

Test stacked path resolution

PluginFactoryTest::testBasicRead() — Method in class PluginFactoryTest

Test basic config.ini loading.

PluginFactoryTest::testCustomRead() — Method in class PluginFactoryTest

Test loading of a custom .ini file.

PluginFactoryTest::testInheritance() — Method in class PluginFactoryTest

Test inheritance features.

PluginFactoryTest::testInheritanceWithArrayMerging() — Method in class PluginFactoryTest

Test inheritance features with array merging turned on.

PluginFactoryTest::testParentConfigOmission() — Method in class PluginFactoryTest

Test that the plugin factory omits the Parent_Config section from the merged configuration.

PluginFactoryTest::testReadOnlyConfig() — Method in class PluginFactoryTest

Test configuration is read-only.

CacheDecoratorTest::testFromFileAndString() — Method in class CacheDecoratorTest

Read config from while, new file.

CacheDecoratorTest::testFromFileAndStringCached() — Method in class CacheDecoratorTest

Read config from while, cached file.

SearchSpecsReaderTest::testSearchSpecsRead() — Method in class SearchSpecsReaderTest

Test loading of a YAML file.

SearchSpecsReaderTest::testMissingFileRead() — Method in class SearchSpecsReaderTest

Test loading of a non-existent YAML file.

SearchSpecsReaderTest::testYamlLoad() — Method in class SearchSpecsReaderTest

Test direct loading of two single files.

SearchSpecsReaderTest::testYamlMerge() — Method in class SearchSpecsReaderTest

Test merging of two files.

SearchSpecsReaderTest::testParentYaml() — Method in class SearchSpecsReaderTest

Test @parent_yaml directive.

$ UpgradeTest#targetVersionProperty in class UpgradeTest

Target upgrade version

UpgradeTest::testUpgrade11() — Method in class UpgradeTest

Test upgrading from 1.1.

UpgradeTest::testUpgrade12() — Method in class UpgradeTest

Test upgrading from 1.2.

UpgradeTest::testUpgrade13() — Method in class UpgradeTest

Test upgrading from 1.3.

UpgradeTest::testUpgrade14() — Method in class UpgradeTest

Test upgrading from 1.4.

UpgradeTest::testDefaultGenerator() — Method in class UpgradeTest

Test generator upgrade.

UpgradeTest::testSyndetics() — Method in class UpgradeTest

Test Syndetics upgrade.

UpgradeTest::testGooglePreviewUpgrade() — Method in class UpgradeTest

Test Google preview setting upgrade

UpgradeTest::testXidDeprecation() — Method in class UpgradeTest

Test removal of xID settings

UpgradeTest::testPermissionUpgrade() — Method in class UpgradeTest

Test permission upgrade

UpgradeTest::testGoogleWarnings() — Method in class UpgradeTest

Test Google-related warnings.

UpgradeTest::testWorldCatWarnings() — Method in class UpgradeTest

Test WorldCat-related warnings.

UpgradeTest::testWorldCatUpgrades() — Method in class UpgradeTest

Test WorldCat-specific upgrades.

UpgradeTest::testMeaningfulLineDetection() — Method in class UpgradeTest

Test "meaningful line" detection in SolrMarc properties files.

UpgradeTest::testPrimoUpgrade() — Method in class UpgradeTest

Test Primo upgrade.

UpgradeTest::testAmazonCoverWarning() — Method in class UpgradeTest

Test deprecated Amazon cover content warning.

UpgradeTest::testAmazonReviewWarning() — Method in class UpgradeTest

Test deprecated Amazon review content warning.

UpgradeTest::testReCaptcha() — Method in class UpgradeTest

Test ReCaptcha setting migration.

VersionTest::testDefaultDir() — Method in class VersionTest

Test the default directory parameter.

VersionTest::testMissingFile() — Method in class VersionTest

Test with a bad directory.

VersionTest::testKnownVersion() — Method in class VersionTest

Test with a fixture to confirm that the right value is extracted.

WriterTest::testReadFile() — Method in class WriterTest

Test reading from a file.

WriterTest::testReadArray() — Method in class WriterTest

Test constructing text from an array.

WriterTest::testReadString() — Method in class WriterTest

Test reading from a string.

WriterTest::testStandardArray() — Method in class WriterTest

Test constructing text from a non-associative array.

WriterTest::testOutOfOrderArray() — Method in class WriterTest

Test constructing text from a non-associative array with non-consecutive keys.

WriterTest::testAssocArray() — Method in class WriterTest

Test constructing text from an associative array.

WriterTest::testBasicSet() — Method in class WriterTest

Test setting a value.

WriterTest::testSetDuplicateValue() — Method in class WriterTest

Test setting a duplicate value.

WriterTest::testAddMissingSection() — Method in class WriterTest

Test that we add a missing section at the end if necessary.

WriterTest::testCommentMaintenance() — Method in class WriterTest

Test that comments are maintained.

WriterTest::testInsertEmpty() — Method in class WriterTest

Test inserting an empty setting.

WriterTest::testTabAlignment() — Method in class WriterTest

Test alignment of values.

WriterTest::testClear() — Method in class WriterTest

Test clearing values.

YamlReaderTest::testCacheWrite() — Method in class YamlReaderTest

Test that the cache is updated as expected.

YamlReaderTest::testCacheRead() — Method in class YamlReaderTest

Test that the cache can short-circuit data loading.

YamlReaderTest::testCacheForcedReload() — Method in class YamlReaderTest

Test that we can force a reload from cache.

YamlReaderTest::testParentConfig() — Method in class YamlReaderTest

Test @parent_yaml and @merged_sections directives

WikipediaTest::testEnglishJane() — Method in class WikipediaTest

Test processing of English-language Jane Austen entry.

WorldCatUtilsTest::testGetRelatedIdentities() — Method in class WorldCatUtilsTest

Test related identities

WorldCatUtilsTest::testGetRelatedIdentitiesEmptyString() — Method in class WorldCatUtilsTest

Test related identities on an empty string

$ MockContainerTrait#testProperty in class MockContainerTrait

Test case (for building mock objects)

TemplateBasedTestClass in namespace VuFindTest\ContentBlock

TemplateBased ContentBlack Test Class

TemplateBasedTest::testBasicPhtmlFunctionality() — Method in class TemplateBasedTest

Test basic functionality of .phtml content block.

TemplateBasedTest::testBasicPhtmlFunctionalityWithContextOverrides() — Method in class TemplateBasedTest

Test basic functionality of .phtml content block, with overrides sent to the getContext method.

TemplateBasedTest::testI18nPhtmlFunctionality() — Method in class TemplateBasedTest

Test functionality of .phtml content block w/ i18n.

TemplateBasedTest::testBasicMarkdownFunctionality() — Method in class TemplateBasedTest

Test basic functionality of Markdown content block.

BokinfoTest::testValidCoverLoading() — Method in class BokinfoTest

Test cover loading

BokinfoTest::testMissingIsbn() — Method in class BokinfoTest

Test missing ISBN

BokinfoTest::testMissingKey() — Method in class BokinfoTest

Test missing API key

BooksiteTest::testValidCoverLoading() — Method in class BooksiteTest

Test cover loading

BooksiteTest::testMissingIsbn() — Method in class BooksiteTest

Test missing ISBN

BuchhandelTest::testValidCoverLoading() — Method in class BuchhandelTest

Test cover loading

BuchhandelTest::testMissingIsbn() — Method in class BuchhandelTest

Test missing ISBN

ContentCafeTest::testValidCoverLoading() — Method in class ContentCafeTest

Test cover loading

ContentCafeTest::testMissingIsbn() — Method in class ContentCafeTest

Test missing ISBN

DeprecatedTest::testEverythingDisabled() — Method in class DeprecatedTest

Test that the handler never actually does anything.

LibraryThingTest::testValidCoverLoading() — Method in class LibraryThingTest

Test cover loading

LibraryThingTest::testMissingIsbn() — Method in class LibraryThingTest

Test missing ISBN

OpenLibraryTest::testValidCoverLoading() — Method in class OpenLibraryTest

Test cover loading

OpenLibraryTest::testMissingIsbn() — Method in class OpenLibraryTest

Test missing ISBN

SummonTest::testValidCoverLoading() — Method in class SummonTest

Test cover loading

SummonTest::testMissingIsbn() — Method in class SummonTest

Test missing ISBN

PageLocatorTest::testDetermineTemplateAndRenderer() — Method in class PageLocatorTest

Test determining a template and renderer.

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

DevtoolsControllerTest::testLanguageAction() — Method in class DevtoolsControllerTest

Test language action.

ResponseFormatterTraitTest::testGetJsonResponse() — Method in class ResponseFormatterTraitTest

Test the getJsonResponse method

ResponseFormatterTraitTest::testAddCorsHeaders() — Method in class ResponseFormatterTraitTest

Test the addCorsHeaders method

InstallControllerTest::testGetMinimalPhpVersionWithActualData() — Method in class InstallControllerTest

Test getMinimalPhpVersion with actual composer.json file

InstallControllerTest::testGetMinimalPhpVersionWithMissingFile() — Method in class InstallControllerTest

Simulate missing composer.json file

InstallControllerTest::testGetMinimalPhpVersionWithMissingPhpVersion() — Method in class InstallControllerTest

Simulate no PHP version defined in composer.json file

InstallControllerTest::testGetMinimalPhpVersion() — Method in class InstallControllerTest

Test getMinimalPhpVersion with actual composer.json file

LanguageHelperTest::testGetLangName() — Method in class LanguageHelperTest

Test language mappings.

LanguageHelperTest::testComparison() — Method in class LanguageHelperTest

Test language comparison.

FollowupTest::testClear() — Method in class FollowupTest

Test clear behavior

FollowupTest::testRetrieve() — Method in class FollowupTest

Test retrieve

FollowupTest::testRetrieveAndClear() — Method in class FollowupTest

Test retrieve and clear

HoldsTest::testValidateIds() — Method in class HoldsTest

Test validateIds method

NewItemsTest::testGetBibIDsFromCatalog() — Method in class NewItemsTest

Test ILS bib ID retrieval.

NewItemsTest::testGetBibIDsFromCatalogWithIDLimit() — Method in class NewItemsTest

Test ILS bib ID retrieval with ID limit.

NewItemsTest::testGetFundList() — Method in class NewItemsTest

Test default ILS getFunds() behavior.

NewItemsTest::testGetFundListWithoutILS() — Method in class NewItemsTest

Test getFundList() in non-ILS mode.

NewItemsTest::testGetSingleHiddenFilter() — Method in class NewItemsTest

Test a single hidden filter.

NewItemsTest::testGetMultipleHiddenFilters() — Method in class NewItemsTest

Test a single hidden filter.

NewItemsTest::testDefaults() — Method in class NewItemsTest

Test various default values.

NewItemsTest::testCustomRanges() — Method in class NewItemsTest

Test custom range settings.

NewItemsTest::testCustomResultPages() — Method in class NewItemsTest

Test custom result pages setting.

NewItemsTest::testIllegalResultPages() — Method in class NewItemsTest

Test illegal result pages setting.

NewItemsTest::testGetSolrFilter() — Method in class NewItemsTest

Test Solr filter generator.

$ ResultScrollerMock#testResultsProperty in class ResultScrollerMock

Search results to return

ResultScrollerTest::testNextPrevNavBug() — Method in class ResultScrollerTest

Test next_prev_nav bug Expect next_prev to behave like it's disabled if the last search didn't return any results

ResultScrollerTest::testDisabled() — Method in class ResultScrollerTest

Test disabled behavior

ResultScrollerTest::testScrollingOnSingleRecord() — Method in class ResultScrollerTest

Test scrolling on single-record set

ResultScrollerTest::testScrollingInMiddleOfPage() — Method in class ResultScrollerTest

Test scrolling for a record in the middle of the page

ResultScrollerTest::testScrollingToFirstRecord() — Method in class ResultScrollerTest

Test scrolling to the first record in a set.

ResultScrollerTest::testScrollingToFirstRecordWithPageSize1() — Method in class ResultScrollerTest

Test scrolling to the first record in a set (with page size set to 1).

ResultScrollerTest::testScrollingToLastRecord() — Method in class ResultScrollerTest

Test scrolling to the last record in a set (with multiple records on the last page of results).

ResultScrollerTest::testScrollingToLastRecordAcrossPageBoundaries() — Method in class ResultScrollerTest

Test scrolling to the last record in a set (with only one record on the last page of results).

ResultScrollerTest::testDisabledFirstLast() — Method in class ResultScrollerTest

Test that first/last results can be disabled (this is the same as the testScrollingInMiddleOfPage() test, but with first/last setting off).

ResultScrollerTest::testScrollingAtStartOfFirstPage() — Method in class ResultScrollerTest

Test scrolling for a record at the start of the first page

ResultScrollerTest::testScrollingAtEndOfLastPage() — Method in class ResultScrollerTest

Test scrolling for a record at the end of the last page (single-page example)

ResultScrollerTest::testScrollingAtEndOfLastPageInMultiPageScenario() — Method in class ResultScrollerTest

Test scrolling for a record at the end of the last page (multi-page example)

ResultScrollerTest::testScrollingAtStartOfMiddlePage() — Method in class ResultScrollerTest

Test scrolling at beginning of middle page.

ResultScrollerTest::testScrollingAtEndOfMiddlePage() — Method in class ResultScrollerTest

Test scrolling at end of middle page.

ResultScrollerTest::testScrollingAtEndOfMiddlePageWithSorting() — Method in class ResultScrollerTest

Test scrolling at end of middle page with sorting.

SocialstatsControllerTest::testHome() — Method in class SocialstatsControllerTest

Test language mappings.

ContainerTest::tearDown() — Method in class ContainerTest

Teardown method: empty container.

ContainerTest::testSettersAndGetters() — Method in class ContainerTest

Test getters and setters

ContainerTest::testIssetAndUnset() — Method in class ContainerTest

Test isset/unset

$ LoaderTest#testThemeProperty in class LoaderTest

Theme to use for testing purposes.

LoaderTest::testUtterFailure() — Method in class LoaderTest

Test that failure to load even the baseline image causes an exception.

LoaderTest::testDefaultLoadingForContentType() — Method in class LoaderTest

Test that requesting a content type causes default data to load.

LoaderTest::testDefaultLoadingForImage() — Method in class LoaderTest

Test that requesting an image causes default data to load.

LoaderTest::testMissingUserSpecifiedFailImage() — Method in class LoaderTest

Test missing user-specified fail image

LoaderTest::testFailImageIllegalExtension() — Method in class LoaderTest

Test illegal file extension

$ RouterTest#testThemeProperty in class RouterTest

Theme to use for testing purposes.

RouterTest::testUnsupportedThumbnail() — Method in class RouterTest

Test a record driver with no thumbnail data.

RouterTest::testStaticUrl() — Method in class RouterTest

Test a record driver with static thumbnail data.

RouterTest::testDynamicUrl() — Method in class RouterTest

Test a record driver with dynamic thumbnail data.

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

Base62Test::testEncode() — Method in class Base62Test

Test encoding.

Base62Test::testDecode() — Method in class Base62Test

Test decoding.

HMACTest::testHash() — Method in class HMACTest

Test hashing.

$ CssPreCompilerTest#testDestProperty in class CssPreCompilerTest

Our brave test subject

CssPreCompilerTest::testThemeCompile() — Method in class CssPreCompilerTest

Test compiling a single theme.

CssPreCompilerTest::testAllCompile() — Method in class CssPreCompilerTest

Test compiling all themes (default).

CssPreCompilerTest::tearDownAfterClass() — Method in class CssPreCompilerTest

Final teardown method.

ChangeTrackerTest::testChangeTracker() — Method in class ChangeTrackerTest

Test change tracking

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

UserListTest::testLoginRequiredToCreateList() — Method in class UserListTest

Test that an exception is thrown if a non-logged-in user tries to create a new list.

UserListTest::testNewListContainsCreatorUserId() — Method in class UserListTest

Test that a new list contains the appropriate user ID.

UserListTest::testNewListsAreDistinct() — Method in class UserListTest

Test that new lists are distinct (not references to same object).

BrowZineTest::testApiSuccess() — Method in class BrowZineTest

Test an API response.

UnpaywallTest::testConfigValidation() — Method in class UnpaywallTest

Test configuration validation.

UnpaywallTest::testApiSuccess() — Method in class UnpaywallTest

Test an API response.

HttpDownloadExceptionTest::testException() — Method in class HttpDownloadExceptionTest
PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

ExportTest::testGetBulkOptionsLegacy() — Method in class ExportTest

Test options using legacy (deprecated) configuration.

ExportTest::testGetActiveFormats() — Method in class ExportTest

Test active formats.

ExportTest::testNeedsRedirect() — Method in class ExportTest

Test "needs redirect"

ExportTest::testProcessGroupNonXML() — Method in class ExportTest

Test non-XML case of process group

ExportTest::testProcessGroupXML() — Method in class ExportTest

Test XML case of process group

ExportTest::testRecordSupportsFormat() — Method in class ExportTest

Test recordSupportsFormat

ExportTest::testGetFormatsForRecord() — Method in class ExportTest

Test getFormatsForRecord

ExportTest::testGetFormatsForRecords() — Method in class ExportTest

Test getFormatsForRecords

ExportTest::testGetHeaders() — Method in class ExportTest

Test getHeaders

ExportTest::testGetRedirectUrl() — Method in class ExportTest

Test getRedirectUrl

ExportTest::testGetLabel() — Method in class ExportTest

Test getLabelForFormat

ExportTest::testGetBulkExportType() — Method in class ExportTest

Test getBulkExportType()

ExportTest::testGetBulkUrl() — Method in class ExportTest

Test getBulkUrl() method

ExportTest::testGetPostField() — Method in class ExportTest

Test getPostField()

ExportTest::testGetTargetWindow() — Method in class ExportTest

Test getTargetWindow()

TranslatorTraitClass in namespace VuFindTest\Feature

Trait for tests involving Laminas Translator.

FeedTest::testIllegalLinkFeedType() — Method in class FeedTest

Test illegal feed type.

FeedTest::testLinks() — Method in class FeedTest

Test basic use of addOpensearchLink/getOpensearchLinks.

FormTest::testDefaultsWithoutConfiguration() — Method in class FormTest

Test defaults with no configuration.

FormTest::testDefaultsWithConfiguration() — Method in class FormTest

Test defaults with defaults passed to constructor.

FormTest::testUndefinedFormId() — Method in class FormTest

Test that the class blocks unknown form IDs.

FormTest::testDefaultsWithFormSet() — Method in class FormTest

Test defaults with no configuration.

FormTest::testSenderFieldMerging() — Method in class FormTest

Test sender field merging.

FormTest::testSenderFieldMergingWithSettings() — Method in class FormTest

Test sender field merging.

FormTest::testElementOptions() — Method in class FormTest

Test element options (select, radio, checkbox).

FormTest::testElementOptionValueValidators() — Method in class FormTest

Test element option value validators (select, radio, checkbox).

FormTest::testCheckboxRequiredValidators() — Method in class FormTest

Test checkbox element 'required' and 'requireOne' option validators.

FormTest::testEmailSubjects() — Method in class FormTest

Test email subjects.

EmailTest::testDefaultEmailBehaviorNoConfig() — Method in class EmailTest

Test default email values with no configuration specified.

EmailTest::testDefaultEmailBehaviorWithConfig() — Method in class EmailTest

Test default email values with configuration specified.

FacetFormatterTest::testFormatter() — Method in class FacetFormatterTest

Test the facet formatter

FacetFormatterTest::testFormatterWithFiltering() — Method in class FacetFormatterTest

Test the facet formatter with filtering turned on

RecordFormatterTest::testFormatter() — Method in class RecordFormatterTest

Test the record formatter.

RecordFormatterTest::testFieldSpecs() — Method in class RecordFormatterTest

Test getting the field specs.

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

CachingDownloaderTest::testDownload() — Method in class CachingDownloaderTest
CachingDownloaderTest::testException() — Method in class CachingDownloaderTest
ExtendedIniNormalizerTest::testLanguageFileIntegrity() — Method in class ExtendedIniNormalizerTest

Test consistent normalization of translation files on disk. This tests not only the functionality of ExtendedIniNormalizer but also the integrity of the language files themselves.

ExtendedIniNormalizerTest::testLanguageFileCheck() — Method in class ExtendedIniNormalizerTest

Test bypassing of non-language-files.

ExtendedIniNormalizerTest::testLanguageFileSectionCheck() — Method in class ExtendedIniNormalizerTest

Test bypassing of files with sections.

LocaleDetectorFactoryTest::testStrategyListWithNoSettings() — Method in class LocaleDetectorFactoryTest

Test that we get the full strategy list by default.

LocaleDetectorFactoryTest::testStrategyListWithBrowserDetection() — Method in class LocaleDetectorFactoryTest

Test that we get the full strategy list when browser language detection is on.

LocaleDetectorFactoryTest::testStrategyListWithoutBrowserDetection() — Method in class LocaleDetectorFactoryTest

Test that we get an abridged strategy list when browser language detection is disabled.

LocaleSettingsTest::testDefaultLocaleRequired() — Method in class LocaleSettingsTest

Confirm that an exception is thrown if no language is specified.

LocaleSettingsTest::testDefaultMustBeEnabled() — Method in class LocaleSettingsTest

Confirm that an exception is thrown if a non-enabled language is set as default.

LocaleSettingsTest::testDefaultConfigs() — Method in class LocaleSettingsTest

Confirm default settings for nearly-empty configuration.

LocaleSettingsTest::testDisablingBrowserLanguageDetection() — Method in class LocaleSettingsTest

Test that browser detection can be disabled.

LocaleSettingsTest::testRightToLeft() — Method in class LocaleSettingsTest

Confirm that right-to-left setting works as expected.

LocaleSettingsTest::testInitializationStatusFlagging() — Method in class LocaleSettingsTest

Test initialization status.

SorterTest::testCompare() — Method in class SorterTest

Test compare function

SorterTest::testSort() — Method in class SorterTest

Test sort function

SorterTest::testAsort() — Method in class SorterTest

Test asort function

SorterTest::testNatsort() — Method in class SorterTest

Test natsort function

ExtendedIniReaderTest::testNonJoinerOptions() — Method in class ExtendedIniReaderTest

Test non-joiner functionality.

ExtendedIniTest::testTranslations() — Method in class ExtendedIniTest

Test translations.

ExtendedIniTest::testFallback() — Method in class ExtendedIniTest

Test fallback to a different language.

ExtendedIniTest::testFallbackToSelf() — Method in class ExtendedIniTest

Test fallback to the same language.

ExtendedIniTest::testSelfAsParent() — Method in class ExtendedIniTest

Test file with self as parent.

ExtendedIniTest::testParentChain() — Method in class ExtendedIniTest

Test file with a chain of parents.

ExtendedIniTest::testMissingPathStack() — Method in class ExtendedIniTest

Test missing path stack.

TranslatableStringTestClass in namespace VuFindTest\I18n\Translator\Loader

TranslatableString Test Class

TranslatableStringTest::testWithoutTranslate() — Method in class TranslatableStringTest

Test standalone behavior.

AlephTest::testGetMyFines() — Method in class AlephTest
$ DAIATest#testResultProperty in class DAIATest
DAIATest::testJSONgetStatus() — Method in class DAIATest
Test
DAIATest::testXMLgetStatus() — Method in class DAIATest
Test
DemoTest::testPatronLogin() — Method in class DemoTest

Test that patron login method always returns a fake user.

$ FolioTest#testResponsesProperty in class FolioTest

Test data for simulated HTTP responses (reset by each test)

$ FolioTest#testRequestLogProperty in class FolioTest

Log of requests made during test (reset by each test)

FolioTest::testTokens() — Method in class FolioTest

Request a token where one does not exist

FolioTest::testCheckValidToken() — Method in class FolioTest

Check a valid token retrieved from session cache

FolioTest::testCheckInvalidToken() — Method in class FolioTest

Check and renew an invalid token retrieved from session cache

FolioTest::testCancelHoldsPatronValidation() — Method in class FolioTest

Confirm that cancel holds validates the current patron.

FolioTest::testCancelHoldsMixedStatuses() — Method in class FolioTest

Confirm that cancel holds processes various statuses appropriately.

FolioTest::testUnsuccessfulPatronLogin() — Method in class FolioTest

Test an unsuccessful patron login with default settings

FolioTest::testSuccessfulPatronLoginWithOkapi() — Method in class FolioTest

Test patron login with Okapi

FolioTest::testSuccessfulPlaceHold() — Method in class FolioTest

Test successful place hold

FolioTest::testSuccessfulRenewMyItems() — Method in class FolioTest

Test successful renewal

FolioTest::testNoItemsGetMyHolds() — Method in class FolioTest

Test successful call to holds, no items

FolioTest::testAvailbleItemGetMyHolds() — Method in class FolioTest

Test successful call to holds, one available item

FolioTest::testInTransitItemGetMyHolds() — Method in class FolioTest

Test successful call to holds, one in_transit item

FolioTest::testSingleItemGetMyHolds() — Method in class FolioTest

Test successful call to holds, item in queue, position x

FolioTest::testIsHoldableDefaultConfig() — Method in class FolioTest

Test calls to isHoldable when no excludeHoldLocationsCompareMode config value is set

FolioTest::testIsHoldableExactMode() — Method in class FolioTest

Test calls to isHoldable with the exact compare mode

FolioTest::testIsHoldableRegexMode() — Method in class FolioTest

Test calls to isHoldable when using regex mode

FolioTest::testIsHoldableInvalidRegex() — Method in class FolioTest

Test calls to isHoldable to verify handling of invalid regex when in regex compare mode

FolioTest::testIsHoldableCaseSensitivityConfig() — Method in class FolioTest

Test calls to isHoldable that verify that the excludeHoldLocationsCompareMode config is case insensitive

FolioTest::testIsHoldableExactModeInvalidInput() — Method in class FolioTest

Test calls to isHoldable using exact mode with invalid location values and paramter values to isHoldable

GeniePlusTest::testAPIFailure() — Method in class GeniePlusTest

Test API failure

GeniePlusTest::testTokenAutoRenewal() — Method in class GeniePlusTest

Test token auto-renewal

GeniePlusTest::testPatronLogin() — Method in class GeniePlusTest

Test patron login

GeniePlusTest::testGetHoldingWithDefaultSort() — Method in class GeniePlusTest

Test holdings lookup with default sort

GeniePlusTest::testGetHoldingWithNonDefaultAscendingSort() — Method in class GeniePlusTest

Test holdings lookup with custom ascending sort

GeniePlusTest::testGetHoldingWithNonDefaultDescendingSort() — Method in class GeniePlusTest

Test holdings lookup with custom descending sort

GeniePlusTest::testGetMyProfile() — Method in class GeniePlusTest

Test profile retrieval

GeniePlusTest::testGetMyTransactions() — Method in class GeniePlusTest

Test transaction retrieval

KohaILSDITest::testToKohaDate() — Method in class KohaILSDITest

Test toKohaDate method

MultiBackendTest::testMissingConfiguration() — Method in class MultiBackendTest

Test that driver complains about missing configuration.

MultiBackendTest::testMissingILSConfiguration() — Method in class MultiBackendTest

Test that driver handles missing ILS driver configuration properly.

MultiBackendTest::testILSConfigurationPathWithoutDriverConfigPath() — Method in class MultiBackendTest

Test that driver handles ILS driver configuration loading properly when drivers_config_path is not defined.

MultiBackendTest::testILSConfigurationPathWithDriverConfigPath() — Method in class MultiBackendTest

Test that driver handles ILS driver configuration loading properly when drivers_config_path is not defined.

MultiBackendTest::testInitialization() — Method in class MultiBackendTest

Test that MultiBackend can be properly initialized.

MultiBackendTest::testLogging() — Method in class MultiBackendTest

Tests that logging works correctly

MultiBackendTest::testGetSourceFromParams() — Method in class MultiBackendTest

Testing method for getSourceFromParams

MultiBackendTest::testGetDriver() — Method in class MultiBackendTest

Test that MultiBackend can properly retrieve a new driver.

MultiBackendTest::testGetDriverConfig() — Method in class MultiBackendTest

Tests that getDriverConfig works correctly

MultiBackendTest::testAddIdPrefixes() — Method in class MultiBackendTest

Testing method for addIdPrefixes

MultiBackendTest::testStripIdPrefixes() — Method in class MultiBackendTest

Testing method for stripIdPrefixes

MultiBackendTest::testDriverSupportsMethod() — Method in class MultiBackendTest

Testing method for driverSupportsMethod

MultiBackendTest::testGetHolding() — Method in class MultiBackendTest

Testing method for getHolding

MultiBackendTest::testGetPurchaseHistory() — Method in class MultiBackendTest

Testing method for getPurchaseHistory

MultiBackendTest::testGetLoginDrivers() — Method in class MultiBackendTest

Testing method for getLoginDrivers

MultiBackendTest::testGetDefaultLoginDriver() — Method in class MultiBackendTest

Testing method for getDefaultLoginDriver

MultiBackendTest::testGetStatus() — Method in class MultiBackendTest

Testing method for getStatus

MultiBackendTest::testGetStatuses() — Method in class MultiBackendTest

Testing method for getStatuses

MultiBackendTest::testGetLocalId() — Method in class MultiBackendTest

This method tests getLocalId.

MultiBackendTest::testDefaultDriver() — Method in class MultiBackendTest

Test that MultiBackend can find and use the default ILS driver if parameters don't include a detectable source id

MultiBackendTest::testGetNewItemsNoDefault() — Method in class MultiBackendTest

Testing method for getNewItems without a default driver

MultiBackendTest::testGetNewItems() — Method in class MultiBackendTest

Testing method for getNewItems with a default driver

MultiBackendTest::testGetCoursesNoDefault() — Method in class MultiBackendTest

Testing method for getCourses without a default driver

MultiBackendTest::testGetCourses() — Method in class MultiBackendTest

Testing method for getCourses with a default driver

MultiBackendTest::testGetDepartmentsNoDefault() — Method in class MultiBackendTest

Testing method for getDepartments without a default driver

MultiBackendTest::testGetDepartments() — Method in class MultiBackendTest

Testing method for getDepartments

MultiBackendTest::testGetInstructorsNoDefault() — Method in class MultiBackendTest

Testing method for getInstructors without a default driver

MultiBackendTest::testGetInstructors() — Method in class MultiBackendTest

Testing method for getInstructors

MultiBackendTest::testFindReservesNoDefault() — Method in class MultiBackendTest

Testing method for findReserves without a default driver

MultiBackendTest::testFindReserves() — Method in class MultiBackendTest

Testing method for findReserves

MultiBackendTest::testGetMyProfile() — Method in class MultiBackendTest

Testing method for getMyProfile

MultiBackendTest::testPatronLogin() — Method in class MultiBackendTest

Test that MultiBackend can properly find a driver and pass log in credentials to it

MultiBackendTest::testGetMyTransactions() — Method in class MultiBackendTest

Testing method for getMyTransactions

MultiBackendTest::testGetRenewDetails() — Method in class MultiBackendTest

Testing method for getRenewDetails

MultiBackendTest::testRenewMyItems() — Method in class MultiBackendTest

Testing method for renewMyItems

MultiBackendTest::testGetMyFines() — Method in class MultiBackendTest

Testing method for getMyFines

MultiBackendTest::testGetHoldLink() — Method in class MultiBackendTest

Testing method for getHoldLink

MultiBackendTest::testGetMyHolds() — Method in class MultiBackendTest

Testing method for getMyHolds

MultiBackendTest::testGetAccountBlocks() — Method in class MultiBackendTest

Testing method for getAccountBlocks

MultiBackendTest::testGetRequestBlocks() — Method in class MultiBackendTest

Testing method for getRequestBlocks

MultiBackendTest::testGetMyStorageRetrievalRequests() — Method in class MultiBackendTest

Testing method for getMyStorageRetrievalRequests

MultiBackendTest::testCheckRequestIsValid() — Method in class MultiBackendTest

Testing method for checkRequestIsValid

MultiBackendTest::testCheckStorageRetrievalRequestIsValid() — Method in class MultiBackendTest

Testing method for checkStorageRetrievalRequestIsValid

MultiBackendTest::testGetPickUpLocations() — Method in class MultiBackendTest

Testing method for getPickUpLocations

MultiBackendTest::testGetDefaultPickUpLocation() — Method in class MultiBackendTest

Testing method for getDefaultPickUpLocation

MultiBackendTest::testGetRequestGroups() — Method in class MultiBackendTest

Testing method for getRequestGroups

MultiBackendTest::testGetDefaultRequestGroup() — Method in class MultiBackendTest

Testing method for getDefaultRequestGroup

MultiBackendTest::testPlaceHold() — Method in class MultiBackendTest

Testing method for placeHold

MultiBackendTest::testCancelHolds() — Method in class MultiBackendTest

Testing method for cancelHolds

MultiBackendTest::testGetCancelHoldDetails() — Method in class MultiBackendTest

Testing method for getCancelHoldDetails

MultiBackendTest::testPlaceStorageRetrievalRequest() — Method in class MultiBackendTest

Testing method for placeStorageRetrievalRequest

MultiBackendTest::testCancelStorageRetrievalRequests() — Method in class MultiBackendTest

Testing method for cancelStorageRetrievalRequests

MultiBackendTest::testGetCancelStorageRetrievalRequestDetails() — Method in class MultiBackendTest

Testing method for getCancelStorageRetrievalRequestDetails

MultiBackendTest::testCheckILLRequestIsValid() — Method in class MultiBackendTest

Testing method for checkILLRequestIsValid

MultiBackendTest::testGetILLPickupLibraries() — Method in class MultiBackendTest

Testing method for getILLPickupLibraries

MultiBackendTest::testGetILLPickupLocations() — Method in class MultiBackendTest

Testing method for getILLPickupLocations

MultiBackendTest::testPlaceILLRequest() — Method in class MultiBackendTest

Testing method for placeILLRequest

MultiBackendTest::testGetMyILLRequests() — Method in class MultiBackendTest

Testing method for getMyILLRequests

MultiBackendTest::testCancelILLRequests() — Method in class MultiBackendTest

Testing method for cancelILLRequests

MultiBackendTest::testGetCancelILLRequestDetails() — Method in class MultiBackendTest

Testing method for getCancelILLRequestDetails

MultiBackendTest::testGetConfig() — Method in class MultiBackendTest

Testing method for getConfig

MultiBackendTest::testSupportsMethod() — Method in class MultiBackendTest

Test that MultiBackend can properly tell whether or not a driver is has contains a specified method.

NoILSTest::testDefaultOfflineMode() — Method in class NoILSTest

Test that driver defaults to 'ils-offline' mode when no config is provided.

NoILSTest::testDefaultLoginVisibility() — Method in class NoILSTest

Test that driver defaults to visible login mode when no config is provided.

NoILSTest::testDefaultHoldingsVisibility() — Method in class NoILSTest

Test that driver defaults to hidden holdings mode when no config is provided.

NoILSTest::testCustomHoldingsVisibility() — Method in class NoILSTest

Test that driver makes holdings visible when in custom mode.

NoILSTest::testUnsupportedFunctions() — Method in class NoILSTest

Test various methods that aren't expected to actually do anything.

$ PAIATest#transactionsTestResultProperty in class PAIATest
PAIATest::testChangePassword() — Method in class PAIATest
Test
PAIATest::testFees() — Method in class PAIATest
Test
PAIATest::testHolds() — Method in class PAIATest
Test
PAIATest::testRequests() — Method in class PAIATest
Test
PAIATest::testTransactions() — Method in class PAIATest
Test
PAIATest::testProfile() — Method in class PAIATest
Test
PAIATest::testValidRequest() — Method in class PAIATest
Test
PAIATest::testRenewDetails() — Method in class PAIATest
Test
PAIATest::testPlaceHold() — Method in class PAIATest
Test
PAIATest::testPlaceStorageRetrievalRequest() — Method in class PAIATest
Test
PAIATest::testRenew() — Method in class PAIATest
Test
PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

SampleTest::testGetNewItems() — Method in class SampleTest

Test that sample driver never returns new items.

SierraRestTest::testIdExtraction() — Method in class SierraRestTest

Test ID extraction.

SierraRestTest::testDefaultBibFormatting() — Method in class SierraRestTest

Test default ID formatting (no prefixing).

SierraRestTest::testPrefixedBibFormatting() — Method in class SierraRestTest

Test default ID formatting (no prefixing).

SymphonyTest::testBadBaseUrl() — Method in class SymphonyTest

Test that driver complains about invalid base URL configuration.

UnicornTest::testDateFormatting() — Method in class UnicornTest

Test date formatting.

UnicornTest::testMarcParsing() — Method in class UnicornTest

Test MARC holdings parsing.

VoyagerTest::testMarcParsing() — Method in class VoyagerTest

Test MARC holdings parsing.

$ XCNCIP2Test#transactionsTestsProperty in class XCNCIP2Test

Test definition for testGetMyTransactions

XCNCIP2Test::testGetMyTransactions() — Method in class XCNCIP2Test

Test getMyTransactions

XCNCIP2Test::testDisableRenewalsConfiguration() — Method in class XCNCIP2Test

Test disable renewals configutaion

XCNCIP2Test::testGetMyFines() — Method in class XCNCIP2Test

Test getMyFines

XCNCIP2Test::testPatronLogin() — Method in class XCNCIP2Test

Test patronLogin

XCNCIP2Test::testGetMyHolds() — Method in class XCNCIP2Test

Test getMyHolds

XCNCIP2Test::testGetMyProfile() — Method in class XCNCIP2Test

Test getMyProfile

XCNCIP2Test::testGetMyStorageRetrievalRequests() — Method in class XCNCIP2Test

Test getMyStorageRetrievalRequests

XCNCIP2Test::testGetStatuses() — Method in class XCNCIP2Test

Test getStatuses

XCNCIP2Test::testGetHolding() — Method in class XCNCIP2Test

Test getHolding

XCNCIP2Test::testGetPickupLocations() — Method in class XCNCIP2Test

Test getPickUpLocations

XCNCIP2Test::testPlaceHold() — Method in class XCNCIP2Test

Test placeHold

XCNCIP2Test::testPlaceStorageRetrievalRequest() — Method in class XCNCIP2Test

Test placeStorageRetrievalRequest

XCNCIP2Test::testCancelHolds() — Method in class XCNCIP2Test

Test cancelHolds

XCNCIP2Test::testCancelStorageRetrievalRequests() — Method in class XCNCIP2Test

Test cancelHolds

XCNCIP2Test::testRenewMyItems() — Method in class XCNCIP2Test

Test renewMyItems

XCNCIP2Test::testGetRequestMethods() — Method in class XCNCIP2Test

Test methods for creating NCIP requests

XCNCIP2Test::testGetCancelRequestException() — Method in class XCNCIP2Test

Test that getCancelRequest throws exception without mandatory parameters (itemId or requestId)

XCNCIP2Test::testGetPatronBlocks() — Method in class XCNCIP2Test

Test method getPatronBlocks

XCNCIP2Test::testGetAccountBlocks() — Method in class XCNCIP2Test

Test method getPatronBlocks

XCNCIP2Test::testIsPatronBlocked() — Method in class XCNCIP2Test

Test method for isPatronBlocked

XCNCIP2Test::testParseProblem() — Method in class XCNCIP2Test

Test parse problem method

XCNCIP2Test::testAcceptOtherHttpStastusCodes() — Method in class XCNCIP2Test

Test other accepted HTTP status code configuration

XCNCIP2Test::testInvalidateResponseCache() — Method in class XCNCIP2Test

Test invalidateResponseCache

XCNCIP2Test::testGetBib() — Method in class XCNCIP2Test

Test getBib method

OAuth2TokenTraitTest::testGetNewOAuth2Token() — Method in class OAuth2TokenTraitTest

Test for getNewOauth2Token

PaginationHelperTest::testPaginationSupported() — Method in class PaginationHelperTest

Test options supporting pagination

PaginationHelperTest::testPaginationNotSupported() — Method in class PaginationHelperTest

Test options not supporting pagination

SolrAuthTest::testSimpleSearch() — Method in class SolrAuthTest

Check that we can find a record in the authority core.

SolrTest::testAlphaBrowseSeeAlso() — Method in class SolrTest

Check AlphaBrowse "see also" functionality.

SolrTest::testAlphaBrowseUseInstead() — Method in class SolrTest

Check AlphaBrowse "use instead" functionality.

SolrTest::testDeweyValues() — Method in class SolrTest

Check that expected Dewey values are present (tests VUFIND-701).

SolrTest::testTermsHandler() — Method in class SolrTest

Check that the terms handler is working.

MinkTestCase::tearDown() — Method in class MinkTestCase

Standard teardown method.

MinkTestCase::tearDownAfterClass() — Method in class MinkTestCase

Standard tear-down.

ResultFeedTest::testRSS() — Method in class ResultFeedTest

Test feed generation

LoggerTest::testLogException() — Method in class LoggerTest

Test logException()

Office365Test::testWriter() — Method in class Office365Test

Test writer functionality

PostTest::testWriter() — Method in class PostTest

Test writer functionality

SlackTest::testWriter() — Method in class SlackTest

Test writer functionality

MailerTest::testFactoryConfiguration() — Method in class MailerTest

Test that the factory configures the object correctly.

MailerTest::testSend() — Method in class MailerTest

Test sending an email.

MailerTest::testSendWithAddressObjectInSender() — Method in class MailerTest

Test sending an email using an address object for the From field.

MailerTest::testSendWithAddressObjectInRecipient() — Method in class MailerTest

Test sending an email using an address object for the To field.

MailerTest::testSendWithAddressListObjectInRecipient() — Method in class MailerTest

Test sending an email using an address list object for the To field.

MailerTest::testSendWithFromOverride() — Method in class MailerTest

Test sending an email using a from address override.

MailerTest::testSendWithReplyTo() — Method in class MailerTest

Test sending an email using an explicitly set reply-to address.

MailerTest::testSendWithFromOverrideAndReplyTo() — Method in class MailerTest

Test sending an email using a from address override and an explicitly set reply-to address.

MailerTest::testBadTo() — Method in class MailerTest

Test bad to address.

MailerTest::testBadReplyTo() — Method in class MailerTest

Test bad reply-to address.

MailerTest::testEmptyTo() — Method in class MailerTest

Test empty to address.

MailerTest::testTooManyRecipients() — Method in class MailerTest

Test that we only accept one recipient by default

MailerTest::testBadFrom() — Method in class MailerTest

Test bad from address.

MailerTest::testBadFromInAddressObject() — Method in class MailerTest

Test bad from address in Address object.

MailerTest::testTransportException() — Method in class MailerTest

Test transport exception.

MailerTest::testSendLink() — Method in class MailerTest

Test sendLink

MailerTest::testSendRecord() — Method in class MailerTest

Test sendRecord

MailerTest::testResetConnection() — Method in class MailerTest

Test connection reset

MailerTest::testSendMimeMessageWithMultipartAlternativeContentType() — Method in class MailerTest

Test sending an email using with text part and html part and multipart content type.

BEPressTest::testMappings() — Method in class BEPressTest

Test basic functionality of the class.

DublinCoreTest::testMappings() — Method in class DublinCoreTest

Test basic functionality of the class.

EprintsTest::testMappings() — Method in class EprintsTest

Test basic functionality of the class.

HighwirePressTest::testMappings() — Method in class HighwirePressTest

Test basic functionality of the class.

PRISMTest::testMappings() — Method in class PRISMTest

Test basic functionality of the class.

AccountActionsTest::testChangePassword() — Method in class AccountActionsTest

Test changing a password.

AccountActionsTest::testChangeEmailDisabledByDefault() — Method in class AccountActionsTest

Test that changing email is disabled by default.

AccountActionsTest::testChangeEmail() — Method in class AccountActionsTest

Test changing an email.

AccountActionsTest::testDefaultPickUpLocation() — Method in class AccountActionsTest

Test default pick up location

AccountActionsTest::tearDownAfterClass() — Method in class AccountActionsTest

Standard teardown method.

AccountMenuTest::testMenuOffAjaxNoDropdown() — Method in class AccountMenuTest

Test that the menu is absent when enableAjax is true and enableDropdown is false.

AccountMenuTest::testMenuOffNoAjaxNoDropdown() — Method in class AccountMenuTest

Test that the menu is absent when enableAjax is false and enableDropdown is false.

AccountMenuTest::testMenuOffNoAjaxDropdown() — Method in class AccountMenuTest

Test that the menu is absent when enableAjax is false and enableDropdown is true.

AccountMenuTest::testMenuOffAjaxDropdown() — Method in class AccountMenuTest

Test that the menu is absent when enableAjax is true and enableDropdown is true.

AccountMenuTest::testIndividualCacheClearing() — Method in class AccountMenuTest

Set some values and delete them to test VuFind.account.clearCache with parameters.

AccountMenuTest::testGlobalCacheClearing() — Method in class AccountMenuTest

Set some values and delete them to test VuFind.account.clearCache without parameters.

AccountMenuTest::testIconNone() — Method in class AccountMenuTest

Check cases that don't change the account icon

AccountMenuTest::testIconGood() — Method in class AccountMenuTest

Check cases that change the account icon to a happy bell

AccountMenuTest::testIconWarning() — Method in class AccountMenuTest

Check cases that change the account icon to a concerned bell

AccountMenuTest::testIconDanger() — Method in class AccountMenuTest

Check cases that change the account icon to an alarming triangle

AccountMenuTest::testIconClashes() — Method in class AccountMenuTest

More urgent cases should override lower cases

AccountMenuTest::tearDownAfterClass() — Method in class AccountMenuTest

Standard teardown method.

AdvancedSearchTest::testPersistent() — Method in class AdvancedSearchTest

Test persistent

AdvancedSearchTest::testAdvancedSearchForm() — Method in class AdvancedSearchTest

Test that the advanced search form is operational.

AdvancedSearchTest::testAdvancedMultiGroupSearchWithNotOperator() — Method in class AdvancedSearchTest

Test that the advanced search form works correctly with a NOT group combined with another group.

AdvancedSearchTest::testAdvancedSingleGroupSearchWithNotOperator() — Method in class AdvancedSearchTest

Test that a pure NOT search gives us results.

AdvancedSearchTest::testDefaultLimitSorting() — Method in class AdvancedSearchTest

Test default limit sorting

AdvancedSearchTest::testLimitSortingWithOrderOverride() — Method in class AdvancedSearchTest

Test limit sorting with order override

AlphabrowseTest::testExtraAttributeEscaping() — Method in class AlphabrowseTest

Test that extra attributes are escaped correctly.

AuthorSearchTest::testCorporateAuthorSearch() — Method in class AuthorSearchTest

Test searching for a known corporate author

AuthorSearchTest::testPrimaryAuthorSearch() — Method in class AuthorSearchTest

Test searching for a known primary author

BasicTest::testHomePage() — Method in class BasicTest

Test that the home page is available.

BasicTest::testAjaxStatus() — Method in class BasicTest

Test that AJAX availability status is working.

BasicTest::testLanguage() — Method in class BasicTest

Test language switching by checking a link in the footer

BasicTest::testLightboxJumps() — Method in class BasicTest

Test lightbox jump links

BlendedSearchTest::testDisabledSearch() — Method in class BlendedSearchTest

Test disabled blended search

BlendedSearchTest::testSearch() — Method in class BlendedSearchTest

Test blended search

BlendedSearchTest::testSearchCheckboxFilter() — Method in class BlendedSearchTest

Test checkbox filters

BulkTest::testBulkEmail() — Method in class BulkTest

Test that the email control works.

BulkTest::testBulkSave() — Method in class BulkTest

Test that the save control works.

BulkTest::testBulkExport() — Method in class BulkTest

Test that the export control works.

BulkTest::testBulkPrint() — Method in class BulkTest

Test that the print control works.

BulkTest::tearDownAfterClass() — Method in class BulkTest

Standard teardown method.

CallnumberBrowseTest::testFirstAndMsg() — Method in class CallnumberBrowseTest

Test with multiple_call_nos set to first and multiple_locations set to msg

CallnumberBrowseTest::testAllAndMsg() — Method in class CallnumberBrowseTest

Test with multiple_call_nos set to first and multiple_locations set to msg

CallnumberBrowseTest::testMsgAndMsg() — Method in class CallnumberBrowseTest

Test with multiple_call_nos set to first and multiple_locations set to msg

CallnumberBrowseTest::testFirstAndGroup() — Method in class CallnumberBrowseTest

Test with multiple_call_nos set to first and multiple_locations set to group

CallnumberBrowseTest::testAllAndGroup() — Method in class CallnumberBrowseTest

Test with multiple_call_nos set to all and multiple_locations set to msg

CallnumberBrowseTest::testMsgAndGroup() — Method in class CallnumberBrowseTest

Test with multiple_call_nos set to msg and multiple_locations set to group

CallnumberBrowseTest::testStatusFull() — Method in class CallnumberBrowseTest

Test with show_full_status set to true

CartTest::tryAddingNothingToCart() — Method in class CartTest

Click the "add to cart" button with nothing selected; fail if this does not display an appropriate message.

CartTest::tryAddingDuplicatesToCart() — Method in class CartTest

Click the "add to cart" button with duplicate IDs selected; fail if this does not display an appropriate message.

CartTest::testAddingNothing() — Method in class CartTest

Test that adding nothing to the cart triggers an appropriate message.

CartTest::testAddingDuplicates() — Method in class CartTest

Test that adding the same records to the cart multiple times triggers an appropriate message.

CartTest::testOverfillingCart() — Method in class CartTest

Test that the cart limit is enforced from search results.

CartTest::testOverfillingCartFromRecordPage() — Method in class CartTest

Test that the cart limit is enforced from record pages.

CartTest::testAddingMultipleRecordsFromRecordPage() — Method in class CartTest

Test that the record "add to cart" button functions.

CartTest::testFillAndDeleteFromCart() — Method in class CartTest

Test that we can put items in the cart and then remove them with the delete control.

CartTest::testFillAndEmptyCart() — Method in class CartTest

Test that we can put items in the cart and then remove them with the empty button.

CartTest::testFillCartUsingBottomControls() — Method in class CartTest

Test that we can put items in the cart using the bottom checkbox/button.

CartTest::testFillAndEmptyCartWithoutLightbox() — Method in class CartTest

Test that we can put items in the cart and then remove them outside of the lightbox.

CartTest::testCartEmail() — Method in class CartTest

Test that the email control works.

CartTest::testCartSave() — Method in class CartTest

Test that the save control works.

CartTest::testCartExport() — Method in class CartTest

Test that the export control works.

CartTest::testCartExportToThirdParty() — Method in class CartTest

Test that the export control works when redirecting to a third-party site.

CartTest::testCartPrint() — Method in class CartTest

Test that the print control works.

CartTest::testToolbarVisibilityConfigCombinations() — Method in class CartTest
CartTest::tearDownAfterClass() — Method in class CartTest

Standard teardown method.

ChannelsTest::testBasic() — Method in class ChannelsTest

Make sure the page works, channels exists, search

ChannelsTest::testAddChannels() — Method in class ChannelsTest

Add channels button

ChannelsTest::testSwitchToSearch() — Method in class ChannelsTest

Switch to search

ChoiceAuthTest::testCreateDatabaseUser() — Method in class ChoiceAuthTest

Test creating a DB user.

ChoiceAuthTest::testProfile() — Method in class ChoiceAuthTest

Test user profile action.

ChoiceAuthTest::tearDownAfterClass() — Method in class ChoiceAuthTest

Standard teardown method.

CollectionsTest::testBasic() — Method in class CollectionsTest

Test that a collection contains records.

CollectionsTest::testKeywordFilter() — Method in class CollectionsTest

Test that the keyword filter feature works correctly.

CollectionsTest::testContextLinks() — Method in class CollectionsTest

Test that the collection hierarchy tab interface works.

CombinedSearchTest::testCombinedSearchResults() — Method in class CombinedSearchTest

Test that combined results work in non-AJAX mode.

CombinedSearchTest::testCombinedSearchResultsAllAjax() — Method in class CombinedSearchTest

Test that combined results work in AJAX mode.

CombinedSearchTest::testCombinedSearchResultsMixedAjax() — Method in class CombinedSearchTest

Test that combined results work in mixed AJAX/non-AJAX mode.

CookieConsentTest::testCookieConsentDisabled() — Method in class CookieConsentTest

Test cookie consent disabled

CookieConsentTest::testCookieConsent() — Method in class CookieConsentTest

Test cookie consent

FavoritesTest::testAddRecordToFavoritesNewAccount() — Method in class FavoritesTest

Test adding a record to favorites (from the record page) while creating a new account.

FavoritesTest::testAddRecordToFavoritesLogin() — Method in class FavoritesTest

Test adding a record to favorites (from the record page) using an existing account that is not yet logged in.

FavoritesTest::testAddRecordToFavoritesLoggedIn() — Method in class FavoritesTest

Test adding a record to favorites (from the record page) using an existing account that is already logged in.

FavoritesTest::testAddSearchItemToFavoritesNewAccount() — Method in class FavoritesTest

Test adding a record to favorites (from the search results) while creating a new account.

FavoritesTest::testAddSearchItemToFavoritesLogin() — Method in class FavoritesTest

Test adding a record to favorites (from the search results) using an existing account that is not yet logged in.

FavoritesTest::testAddSearchItemToFavoritesLoggedIn() — Method in class FavoritesTest

Test adding a record to favorites (from the search results) using an existing account that is already logged in.

FavoritesTest::testTaggedList() — Method in class FavoritesTest

Test that lists can be tagged when the optional setting is activated.

FavoritesTest::testBulkEmail() — Method in class FavoritesTest

Test that the email control works.

FavoritesTest::testBulkExport() — Method in class FavoritesTest

Test that the export control works.

FavoritesTest::testBulkPrint() — Method in class FavoritesTest

Test that the print control works.

FavoritesTest::testEmailPublicList() — Method in class FavoritesTest

Test that it is possible to email a public list.

FavoritesTest::testPublicListIndicator() — Method in class FavoritesTest

Test that public list indicator appears as expected.

FavoritesTest::testBulkDelete() — Method in class FavoritesTest

Test that the bulk delete control works.

FavoritesTest::tearDownAfterClass() — Method in class FavoritesTest

Standard teardown method.

FeedbackTest::testFeedbackForm() — Method in class FeedbackTest

Test that feedback form can be successfully populated and submitted.

FeedbackTest::testFeedbackFormWithCaptcha() — Method in class FeedbackTest

Test that feedback form can be successfully populated and submitted.

FeedbackTest::testIntervalCaptcha() — Method in class FeedbackTest

Test feedback form with the interval captcha.

HoldsTest::testPlaceHold() — Method in class HoldsTest

Test placing a hold

HoldsTest::testCancelHold() — Method in class HoldsTest

Test canceling a hold.

HoldsTest::testFrozenHoldCreation() — Method in class HoldsTest

Test creating a frozen hold.

HoldsTest::testFrozenHoldEditing() — Method in class HoldsTest

Test creating, and then editing, a frozen hold.

HoldsTest::testEditingDifferentPickupLocations() — Method in class HoldsTest

Test editing two holds with different pickup locations.

HoldsTest::testFrozenHoldEditingWithCancellation() — Method in class HoldsTest

Test creating, and then editing, and then canceling, a frozen hold.

HoldsTest::testHoldsAll() — Method in class HoldsTest

Test create account path when in holds_mode = "all"

HoldsTest::testPlaceHoldWithoutPickUpLocations() — Method in class HoldsTest

Test placing a hold with no valid pick up locations

HoldsTest::tearDownAfterClass() — Method in class HoldsTest

Standard teardown method.

HomePageFacetsTest::testHierarchicalFacets() — Method in class HomePageFacetsTest

Test that hierarchy facets work properly.

IlsActionsTest::testDisabledUserLogin() — Method in class IlsActionsTest

Test that user profile action blocks login with catalog login is disabled.

IlsActionsTest::testProfile() — Method in class IlsActionsTest

Test user profile action.

IlsActionsTest::testIllRequest() — Method in class IlsActionsTest

Test ILL requests.

IlsActionsTest::testCancelAllIllRequest() — Method in class IlsActionsTest

Test canceling an ILL request with "cancel all."

IlsActionsTest::testCancelSelectedIllRequest() — Method in class IlsActionsTest

Test canceling an ILL request with "cancel selected."

IlsActionsTest::testStorageRetrievalRequest() — Method in class IlsActionsTest

Test storage retrieval requests.

IlsActionsTest::testCancelAllStorageRetrievalRequest() — Method in class IlsActionsTest

Test canceling storage retrieval requests with "cancel all."

IlsActionsTest::testCancelSelectedStorageRetrievalRequest() — Method in class IlsActionsTest

Test canceling storage retrieval requests with "cancel selected."

IlsActionsTest::testRenewal() — Method in class IlsActionsTest

Test renewal action.

IlsActionsTest::tearDownAfterClass() — Method in class IlsActionsTest

Standard teardown method.

JumpToRecordTest::testJumpToFirst() — Method in class JumpToRecordTest

Test that we can jump to the first record in a single-record result set.

JumpToRecordTest::testDoNotJumpToFirst() — Method in class JumpToRecordTest

Same as the previous test, but without switching on the jump setting; this should result in a result list.

LinkResolverTest::testLinkInSearchResults() — Method in class LinkResolverTest

Test a link in the search results (default behavior, click required).

LinkResolverTest::testLinkInSearchResultsWithAutoloading() — Method in class LinkResolverTest

Test a link in the search results (optional autoloading enabled).

LinkResolverTest::testLinkOnRecordPageWithDefaultConfig() — Method in class LinkResolverTest

Test that link is missing from the record page by default.

LinkResolverTest::testLinkOnRecordPageWithLinkInCore() — Method in class LinkResolverTest

Test a link on the record page (in core metadata).

LinkResolverTest::testLinkOnRecordPageWithLinkInHoldings() — Method in class LinkResolverTest

Test a link on the record page (in holdings tab).

LinkResolverTest::testLinkOnRecordPageWithLinkInHoldingsAndAjaxTabLoading() — Method in class LinkResolverTest

Test a link on the record page (in holdings tab w/ AJAX loading).

ListViewsTest::testFavoritesInTabMode() — Method in class ListViewsTest

Test that we can save a favorite from tab mode.

ListViewsTest::testFavoritesInAccordionMode() — Method in class ListViewsTest

Test that we can save a favorite from accordion mode.

ListViewsTest::testSavedOpenInTabsMode() — Method in class ListViewsTest

Test localStorage saving from tab mode.

ListViewsTest::testSavedOpenInAccordionMode() — Method in class ListViewsTest

Test localStorage saving from accordion mode.

ListViewsTest::tearDownAfterClass() — Method in class ListViewsTest

Standard teardown method.

NextPrevNavTest::testEmptySearchResultsCauseNoProblems() — Method in class NextPrevNavTest

if next_prev_navigation and first_last_navigation are set to true and a search which returns no results is run when a record page is visited no next prev navigation should be shown and no exception should be thrown

OAuth2Test::testOAuth2Authorization() — Method in class OAuth2Test

Test OAuth2 authorization.

OAuth2Test::testOAuth2Unauthorized() — Method in class OAuth2Test

Test OAuth2 denied authorization.

OAuth2Test::testOAuth2InvalidScope() — Method in class OAuth2Test

Test OAuth2 authorization with invalid scope.

OAuth2Test::testOAuth2InvalidClient() — Method in class OAuth2Test

Test OAuth2 authorization with invalid client.

OAuth2Test::tearDownAfterClass() — Method in class OAuth2Test

Standard teardown method.

RecordActionsTest::testAddComment() — Method in class RecordActionsTest

Test adding comments on records.

RecordActionsTest::testAddCommentWithCaptcha() — Method in class RecordActionsTest

Test adding comments on records (with Captcha enabled).

RecordActionsTest::testAddTag() — Method in class RecordActionsTest

Test adding tags on records.

RecordActionsTest::testTagSearch() — Method in class RecordActionsTest

Test searching for one of the tags created above.

RecordActionsTest::testAddSensitiveTag() — Method in class RecordActionsTest

Test adding case sensitive tags on records.

RecordActionsTest::testEmail() — Method in class RecordActionsTest

Test record view email.

RecordActionsTest::testSMS() — Method in class RecordActionsTest

Test record view SMS.

RecordActionsTest::testPrint() — Method in class RecordActionsTest

Test record view print button.

RecordActionsTest::testRatingDisabled() — Method in class RecordActionsTest

Test rating disabled.

RecordActionsTest::testRating() — Method in class RecordActionsTest

Test star ratings on records.

RecordActionsTest::tearDownAfterClass() — Method in class RecordActionsTest

Standard teardown method.

RecordTest::tryRecordTabsOnId() — Method in class RecordTest

Test record tabs for a particular ID.

RecordTest::tryLoadingTabHashAndReturningToDefault() — Method in class RecordTest

Test that we can start on a hashed URL and then move back to the default tab from there.

RecordTest::testRecordTabsOnNormalId() — Method in class RecordTest

Test that record tabs work with a "normal" ID.

RecordTest::testRecordTabsOnSpacedId() — Method in class RecordTest

Test that record tabs work with an ID with a space in it.

RecordTest::testRecordTabsOnPlusId() — Method in class RecordTest

Test that record tabs work with an ID with a plus in it.

RecordTest::testLoadInitialTabWithAjax() — Method in class RecordTest

Test that tabs work correctly with loadInitialTabWithAjax turned on.

RecordVersionsTest::testVersions() — Method in class RecordVersionsTest

Test accessing a record with multiple versions.

RecordVersionsTest::testVersionsInSearch2() — Method in class RecordVersionsTest

Test accessing a record with multiple versions via secondary search.

RecordVersionsTest::testDisabledVersionsTab() — Method in class RecordVersionsTest

Confirm that links operate differently when the record versions tab is disabled but other version settings are enabled.

RecordVersionsTest::testDisabledVersions() — Method in class RecordVersionsTest

Confirm that version controls do not appear in search results when the setting is disabled.

SavedSearchesTest::testSaveSearch() — Method in class SavedSearchesTest

Test saving and clearing a search.

SavedSearchesTest::testSavedSearchDeduplication() — Method in class SavedSearchesTest

Test that saving a search while logging in does not create a duplicate.

SavedSearchesTest::testSearchHistory() — Method in class SavedSearchesTest

Test search history.

SavedSearchesTest::testSavedSearchSecurity() — Method in class SavedSearchesTest

Test that user A cannot delete user B's favorites.

SavedSearchesTest::testNotificationSettings() — Method in class SavedSearchesTest

Test that notification settings work correctly.

SavedSearchesTest::testNotificationsInSearchToolbar() — Method in class SavedSearchesTest

Test that notifications are accessible via the search toolbar

SavedSearchesTest::testNotificationsInSearchToolbarDeduplication() — Method in class SavedSearchesTest

Test that accessing the "manage schedule" screen properly deduplicates existing saved searches if clicked prior to user login.

SavedSearchesTest::testNotificationsInSearchHistoryDeduplication() — Method in class SavedSearchesTest

Test that scheduling a search from the history screen properly deduplicates existing saved searches if clicked prior to user login.

SavedSearchesTest::tearDownAfterClass() — Method in class SavedSearchesTest

Standard teardown method.

SearchFacetsTest::testApplyFacet() — Method in class SearchFacetsTest

Test applying a facet to filter results (standard facet sidebar)

SearchFacetsTest::testApplyFacetDeferred() — Method in class SearchFacetsTest

Test applying a facet to filter results (deferred facet sidebar)

SearchFacetsTest::testFacetLightbox() — Method in class SearchFacetsTest

Test expanding facets into the lightbox

SearchFacetsTest::testFacetLightboxMoreSetting() — Method in class SearchFacetsTest

Test expanding facets into the lightbox

SearchFacetsTest::testFacetLightboxExclusion() — Method in class SearchFacetsTest

Test that exclusion works properly deep in lightbox results.

SearchFacetsTest::testHierarchicalFacets() — Method in class SearchFacetsTest

Test that hierarchy facets work properly.

SearchFacetsTest::testHierarchicalFacetExclude() — Method in class SearchFacetsTest

Test that hierarchy facet exclusion works properly.

SearchFacetsTest::testCollapseStatePersistence() — Method in class SearchFacetsTest

Test that we can persist uncollapsed state of collapsed facets

SearchFacetsTest::testDefaultRetainFiltersBehavior() — Method in class SearchFacetsTest

Test retain current filters default behavior

SearchFacetsTest::testFiltersOnRecord() — Method in class SearchFacetsTest

Test that filters carry over to selected records and are retained from there.

SearchFacetsTest::testNeverRetainFiltersBehavior() — Method in class SearchFacetsTest

Test "never retain filters" configurable behavior

SearchFacetsTest::testDefaultFiltersWithResetButton() — Method in class SearchFacetsTest

Test resetting to a default filter state

SearchFacetsTest::testOrFacets() — Method in class SearchFacetsTest

Test that OR facets work as expected.

SearchLimitTest::testDefaults() — Method in class SearchLimitTest

Test that default page size is 20, with no limit controls displayed.

SearchLimitTest::testCustomLimits() — Method in class SearchLimitTest

Test that a custom limit behaves as expected.

SearchLimitTest::testInvalidLimits() — Method in class SearchLimitTest

Test that an invalid limit option sends us to the default value.

SearchLimitTest::testNonNumericLimitValues() — Method in class SearchLimitTest

Test that non-numeric limit values in GET parameter are handled correctly.

ShibbolethLogoutNotificationTest::testLogoutNotification() — Method in class ShibbolethLogoutNotificationTest

Test Shibboleth logout notification.

VisualizationTest::testVisualization() — Method in class VisualizationTest

Test that visualization results display correctly.

VisualizationTest::testVisualizationWithoutSideFacets() — Method in class VisualizationTest

Test that visualization results display correctly even when no other recommendation modules are active.

IpAddressUtilsTest::testNormalizeIp() — Method in class IpAddressUtilsTest

Test normalizeIp()

IpAddressUtilsTest::testIsInRange() — Method in class IpAddressUtilsTest

Test isInRange()

UserIpReaderFactoryTest::testDefaults() — Method in class UserIpReaderFactoryTest

Test the factory's defaults

UserIpReaderFactoryTest::testNonDefaultsWithSingleFilteredIP() — Method in class UserIpReaderFactoryTest

Test non-default values, with a single filtered IP

UserIpReaderFactoryTest::testNonDefaultsWithMultipleFilteredIPs() — Method in class UserIpReaderFactoryTest

Test non-default values, with multiple filtered IPs

UserIpReaderTest::testMultipleHeaders() — Method in class UserIpReaderTest

Test X-Real-IP; it should take priority over all other settings when forwarding is allowed.

UserIpReaderTest::testMultipleHeadersWithFilter() — Method in class UserIpReaderTest

Test that filters are applied correctly.

UserIpReaderTest::testFilteredSingle() — Method in class UserIpReaderTest

Test that a single value is extracted correctly after a filter is applied.

UserIpReaderTest::testXForwardedForMultiValued() — Method in class UserIpReaderTest

Test X-Forwarded-For (multi-value); the leftmost IP should take priority over REMOTE_ADDR when forwarding is allowed.

UserIpReaderTest::testXForwardedForWithoutHeaders() — Method in class UserIpReaderTest

Test what happens when only REMOTE_ADDR is provided.

ServerTest::testEmptyInput() — Method in class ServerTest

Test an empty input.

AccessTokenRepositoryTest::testAccessTokenRepository() — Method in class AccessTokenRepositoryTest

Test access token repository

AccessTokenRepositoryTest::testPersistInvalidTokenClass() — Method in class AccessTokenRepositoryTest

Test persisting wrong type of token

AuthCodeRepositoryTest::testAuthCodeRepository() — Method in class AuthCodeRepositoryTest

Test auth code repository

ClientRepositoryTest::testClientRepository() — Method in class ClientRepositoryTest

Test client repository

ClientRepositoryTest::testInvalidConfig() — Method in class ClientRepositoryTest

Test configuration missing attributes

ClientRepositoryTest::testInvalidClientSecretConfig() — Method in class ClientRepositoryTest

Test invalid client secret configuration

IdentityRepositoryTest::testIdentityRepository() — Method in class IdentityRepositoryTest

Test identity repository

IdentityRepositoryTest::testIdentityRepositoryWithFailingILS() — Method in class IdentityRepositoryTest

Test identity repository with a failing ILS connection

RefreshTokenRepositoryTest::testRefreshTokenRepository() — Method in class RefreshTokenRepositoryTest

Test refresh token repository

ScopeRepositoryTest::testScopeRepository() — Method in class ScopeRepositoryTest

Test scope repository

ScopeRepositoryTest::testScopeRepositoryWithInvalidId() — Method in class ScopeRepositoryTest

Test scope repository with invalid id

ScopeRepositoryTest::testInvalidConfig() — Method in class ScopeRepositoryTest

Test scope repository with invalid configuration

ParamBagTest::testContains() — Method in class ParamBagTest

Test "contains"

ParamBagTest::testHasParam() — Method in class ParamBagTest

Test "hasParam"

ParamBagTest::testRemove() — Method in class ParamBagTest

Test "remove"

ParamBagTest::testMergeWithAll() — Method in class ParamBagTest

Test "merge with all"

ParamBagTest::testCountability() — Method in class ParamBagTest

Test countability.

$ LoaderTest#testThemeProperty in class LoaderTest

Theme to use for testing purposes.

LoaderTest::testUtterFailure() — Method in class LoaderTest

Test that failure to load even the baseline image causes an exception.

LoaderTest::testDefaultLoadingForBlankText() — Method in class LoaderTest

Test that requesting a blank QR code returns the fail image.

LoaderTest::testDefaultLoadingForTooSmallImage() — Method in class LoaderTest

Test that requesting a too small image returns the fail image.

QueryGroupTest::testContainsTerm() — Method in class QueryGroupTest

Test containsTerm() method

QueryGroupTest::testGetAllTerms() — Method in class QueryGroupTest

Test getAllTerms() method

QueryGroupTest::testReplaceTerm() — Method in class QueryGroupTest

Test replaceTerm() method

QueryGroupTest::testReplaceTermWithNormalization() — Method in class QueryGroupTest

Test replaceTerm() method with and without normalization using complex input

QueryGroupTest::testClone() — Method in class QueryGroupTest

Test QueryGroup cloning.

QueryGroupTest::testReducedHandler() — Method in class QueryGroupTest

Test setting/clearing of reduced handler.

QueryGroupTest::testIllegalOperator() — Method in class QueryGroupTest

Test setting an invalid operator.

QueryGroupTest::testContainsTermWithNormalization() — Method in class QueryGroupTest

Test detection of normalized terms.

QueryTest::testContainsTerm() — Method in class QueryTest

Test containsTerm() method

QueryTest::testReplaceTerm() — Method in class QueryTest

Test replaceTerm() method

QueryTest::testReplacePunctuatedTerm() — Method in class QueryTest

Test replacing a term containing punctuation; this exercises a special case in the code.

QueryTest::testMultipleReplacements() — Method in class QueryTest

Test multiple replacements -- this simulates the scenario discussed in the VUFIND-1423 JIRA ticket.

QueryTest::testNormalization() — Method in class QueryTest

Test normalization-related logic

QueryTest::testSetHandler() — Method in class QueryTest

Test setHandler() method

QueryTest::testSetOperator() — Method in class QueryTest

Test setOperator() method

CollectionSideFacetsTest::testKeywordFilter() — Method in class CollectionSideFacetsTest

Test "getResults"

DOITest::testEmptyQuery() — Method in class DOITest

Test an empty query.

DOITest::testNonDoiQuery() — Method in class DOITest

Test a non-DOI query.

DOITest::testExactDoiQuery() — Method in class DOITest

Test an exact DOI query.

DOITest::testNonExactDoiQuery() — Method in class DOITest

Test a non-exact DOI query.

DOITest::testDoiRedirectConfigs() — Method in class DOITest

Test configuration of the redirect setting:

EDSResultsDeferredTest::testStandardOperation() — Method in class EDSResultsDeferredTest

Test standard operation

EuropeanaResultsDeferredTest::testStandardOperation() — Method in class EuropeanaResultsDeferredTest

Test standard operation

EuropeanaResultsTest::testResponseParsing() — Method in class EuropeanaResultsTest

Test that the module properly parses a sample response.

ExpandFacetsTest::testGetEmptyResults() — Method in class ExpandFacetsTest

Test getEmptyResults()

ExpandFacetsTest::testFacetInit() — Method in class ExpandFacetsTest

Test facet initialization.

ExternalSearchTest::testDefaultConcatenation() — Method in class ExternalSearchTest

Test concatenation behavior

ExternalSearchTest::testTemplateBehavior() — Method in class ExternalSearchTest

Test template insertion behavior

FacetCloudTest::testGetFacetLimit() — Method in class FacetCloudTest

Test getEmptyResults()

FavoriteFacetsTest::testFacetInitWithDisabledTags() — Method in class FavoriteFacetsTest

Test facet initialization with disabled tags.

FavoriteFacetsTest::testFacetInitWithEnabledTags() — Method in class FavoriteFacetsTest

Test facet initialization with enabled tags.

MapSelectionTest::testGetGeoField() — Method in class MapSelectionTest

Test getter for geofield

MapSelectionTest::testGetHeight() — Method in class MapSelectionTest

Test getter for height

MapSelectionTest::testGetDefaultCoordinates() — Method in class MapSelectionTest

Test getter for default coordinates.

MapSelectionTest::testGetBasemap() — Method in class MapSelectionTest

Test getter for basemap

OpenLibrarySubjectsDeferredTest::testStandardOperation() — Method in class OpenLibrarySubjectsDeferredTest

Test standard operation

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

RandomRecommendTest::testCanSetSettings() — Method in class RandomRecommendTest

Test settings

RandomRecommendTest::testDefaultSettings() — Method in class RandomRecommendTest

Test default settings

RandomRecommendTest::testCanInitialise() — Method in class RandomRecommendTest

Test initialisation

RandomRecommendTest::testCanInitialiseInDisregardMode() — Method in class RandomRecommendTest

Test initialisation

RandomRecommendTest::testWillReturnEmptyForMinimumResultLimit() — Method in class RandomRecommendTest

Test minimum result limit feature

RandomRecommendTest::testWillReturnResults() — Method in class RandomRecommendTest

Test results coming back

RandomRecommendTest::testCanSetDisplayMode() — Method in class RandomRecommendTest

Test displaymode

RecommendLinksTest::testRecommendLinksWithDefaultConfiguration() — Method in class RecommendLinksTest

Test with default configuration.

RecommendLinksTest::testRecommendLinksWithCustomConfiguration() — Method in class RecommendLinksTest

Test with custom configuration.

SideFacetsTest::testGetResults() — Method in class SideFacetsTest

Test "getResults"

SideFacetsTest::testHierarchicalGetters() — Method in class SideFacetsTest

Test getHierarchicalFacets() and getHierarchicalFacetSortOptions()

SideFacetsTest::testMissingHierarchicalFacetHelper() — Method in class SideFacetsTest

Test missing hierarchical facet helper

SideFacetsTest::testFacetInit() — Method in class SideFacetsTest

Test facet initialization.

SideFacetsTest::testGetFacetOperator() — Method in class SideFacetsTest

Test getFacetOperator

SideFacetsTest::testExcludeAllowed() — Method in class SideFacetsTest

Test excludeAllowed

SideFacetsTest::testGetAllRangeFacets() — Method in class SideFacetsTest

Test getAllRangeFacets()

SideFacetsTest::testGetCollapsedFacetsDefault() — Method in class SideFacetsTest

Test default getCollapsedFacets behavior.

SideFacetsTest::testGetCollapsedFacetsDelimitedList() — Method in class SideFacetsTest

Test asterisk support in getCollapsedFacets

SideFacetsTest::testGetCollapsedFacetsWildcard() — Method in class SideFacetsTest

Test delimited list support in getCollapsedFacets

SideFacetsTest::testGetCheckboxFacetSetDefaultsToEmptyArray() — Method in class SideFacetsTest

Test that getCheckboxFacetSet returns an empty array when no checkboxes are requested.

SideFacetsTest::testGetCheckboxFacetSetReturnsValueWhenAppropriate() — Method in class SideFacetsTest

Test that getCheckboxFacetSet returns values when expected.

SideFacetsTest::testDynamicCheckboxesCanBeDisabled() — Method in class SideFacetsTest

Test that dynamic checkboxes can be disabled.

SummonBestBetsDeferredTest::testStandardOperation() — Method in class SummonBestBetsDeferredTest

Test standard operation

SummonBestBetsTest::testGetResults() — Method in class SummonBestBetsTest

Test getting best bets results.

SummonDatabasesDeferredTest::testStandardOperation() — Method in class SummonDatabasesDeferredTest

Test standard operation

SummonDatabasesTest::testGetResults() — Method in class SummonDatabasesTest

Test getting database results.

SummonResultsDeferredTest::testStandardOperation() — Method in class SummonResultsDeferredTest

Test standard operation

SummonResultsTest::testGetSearchClassId() — Method in class SummonResultsTest

Test getting search class id.

SummonTopicsTest::testGetResults() — Method in class SummonTopicsTest

Test getting topic results.

SummonTopicsTest::testInit() — Method in class SummonTopicsTest

Test init.

SummonTopicsTest::testconfigureSummonResults() — Method in class SummonTopicsTest

Test to configure SummonResults.

SwitchQueryTest::testGetResults() — Method in class SwitchQueryTest

Test "getResults"

SwitchQueryTest::testLowercaseBooleans() — Method in class SwitchQueryTest

Test lowercase booleans

SwitchQueryTest::testLowercaseBooleansAndCaseInsensitivity() — Method in class SwitchQueryTest

Test lowercase booleans with case insensitive setting (should be skipped)

SwitchQueryTest::testIdQuery() — Method in class SwitchQueryTest

Test id query

SwitchQueryTest::testAdvancedQuery() — Method in class SwitchQueryTest

Test advanced query

SwitchQueryTest::testUnwantedBools() — Method in class SwitchQueryTest

Test unwanted booleans

SwitchQueryTest::testUnwantedQuotes() — Method in class SwitchQueryTest

Test unwanted quotes

SwitchQueryTest::testTransformUnwantedCharacter() — Method in class SwitchQueryTest

Test transform unwanted character

SwitchQueryTest::testTransformUnwantedCharacterOnPhrase() — Method in class SwitchQueryTest

Test transform unwanted character on phrase (should omit suggestion)

SwitchTabTest::tabConfigProvider() — Method in class SwitchTabTest

Data provider for testGetActiveTab.

SwitchTabTest::testGetActiveTab() — Method in class SwitchTabTest

Test getting the active tab.

SwitchTabTest::testGetInactiveTab() — Method in class SwitchTabTest

Test getting the active tab.

SwitchTabTest::testSetConfig() — Method in class SwitchTabTest

Test storing the configuration of recommendation module.

SwitchTabTest::testProcess() — Method in class SwitchTabTest

Test the process method.

SwitchTypeTest::testGetNewHandlerName() — Method in class SwitchTypeTest

Test the description of new search handler.

SwitchTypeTest::testGetNewHandler() — Method in class SwitchTypeTest

Test getting the new search handler.

SwitchTypeTest::testGetResults() — Method in class SwitchTypeTest

Test get results stored in the object.

WebResultsTest::testGetSearchClassId() — Method in class WebResultsTest

Test getting search class id.

DefaultRecordTest::testGetPublicationDates() — Method in class DefaultRecordTest

Test getPublicationDates for a record.

DefaultRecordTest::testGetCoordinateLabels() — Method in class DefaultRecordTest

Test getCoordinateLabels for a record.

DefaultRecordTest::testGetDisplayCoordinates() — Method in class DefaultRecordTest

Test getDisplayCoordinates for a record.

DefaultRecordTest::testGetGeoLocation() — Method in class DefaultRecordTest

Test getDisplayCoordinates for a record.

DefaultRecordTest::testGetSchemaOrgFormats() — Method in class DefaultRecordTest

Test getSchemaOrgFormats for a record.

DefaultRecordTest::testGetSortTitle() — Method in class DefaultRecordTest

Test getSortTitle for a record.

DefaultRecordTest::testGetContainerReference() — Method in class DefaultRecordTest

Test getContainerReference for a record.

DefaultRecordTest::testGetThumbnail() — Method in class DefaultRecordTest

Test getThumbnail for a record.

DefaultRecordTest::testGetURLs() — Method in class DefaultRecordTest

Test getURLs for a record.

DefaultRecordTest::testGetTOC() — Method in class DefaultRecordTest

Test getURLs for a record.

DefaultRecordTest::testGetSummary() — Method in class DefaultRecordTest

Test getSummary for a record.

DefaultRecordTest::testGetSubtitle() — Method in class DefaultRecordTest

Test getSubtitle for a record.

DefaultRecordTest::testGetSecondaryAuthorsRoles() — Method in class DefaultRecordTest

Test getSecondaryAuthorsRoles for a record.

DefaultRecordTest::testGetSecondaryAuthors() — Method in class DefaultRecordTest

Test getSecondaryAuthors for a record.

DefaultRecordTest::testGetPublicationDetails() — Method in class DefaultRecordTest

Test getPublicationDetails for a record.

DefaultRecordTest::testGetPrimaryAuthorsRoles() — Method in class DefaultRecordTest

Test getPrimaryAuthorsRoles for a record.

DefaultRecordTest::testGetPrimaryAuthor() — Method in class DefaultRecordTest

Test getPrimaryAuthor for a record.

DefaultRecordTest::testGetPreviousTitles() — Method in class DefaultRecordTest

Test getPreviousTitles for a record.

DefaultRecordTest::testGetPhysicalDescriptions() — Method in class DefaultRecordTest

Test getPhysicalDescriptions for a record.

DefaultRecordTest::testGetCoinsOpenUrl() — Method in class DefaultRecordTest

Test getCoinsOpenUrl for a record.

DefaultRecordTest::testGetOpenUrl() — Method in class DefaultRecordTest

Test getOpenUrl for a record.

DefaultRecordTest::testGetNewerTitles() — Method in class DefaultRecordTest

Test getNewerTitles for a record.

DefaultRecordTest::testGetLCCN() — Method in class DefaultRecordTest

Test getLCCN for a record.

DefaultRecordTest::testGetInstitutions() — Method in class DefaultRecordTest

Test getInstitutions for a record.

DefaultRecordTest::testGetLastIndexed() — Method in class DefaultRecordTest

Test getLastIndexed for a record.

DefaultRecordTest::testGetPrimaryAuthorsWithHighlighting() — Method in class DefaultRecordTest

Test getPrimaryAuthorsWithHighlighting for a record.

DefaultRecordTest::testGetDateSpan() — Method in class DefaultRecordTest

Test getDateSpan for a record.

DefaultRecordTest::testGetCorporateAuthorsRoles() — Method in class DefaultRecordTest

Test getCorporateAuthorsRoles for a record.

DefaultRecordTest::testGetCorporateAuthors() — Method in class DefaultRecordTest

Test getCorporateAuthors for a record.

DefaultRecordTest::testGetCleanDOI() — Method in class DefaultRecordTest

Test getCleanDOI for a record.

DefaultRecordTest::testGetCallNumber() — Method in class DefaultRecordTest

Test getCallNumber for a record.

DefaultRecordTest::testGetBreadcrumb() — Method in class DefaultRecordTest

Test getBreadcrumb for a record.

DefaultRecordTest::testCitationBehavior() — Method in class DefaultRecordTest

Test citation behavior.

EDSTest::testGetUniqueID() — Method in class EDSTest

Test getUniqueID for a record.

EDSTest::testGetShortTitle() — Method in class EDSTest

Test getShortTitle for a record.

EDSTest::testGetItemsAbstract() — Method in class EDSTest

Test getItemsAbstract for a record.

EDSTest::testGetAccessLevel() — Method in class EDSTest

Test getAccessLevel for a record.

EDSTest::testGetItemsAuthors() — Method in class EDSTest

Test getItemsAuthors for a record.

EDSTest::testGetCustomLinks() — Method in class EDSTest

Test getCustomLinks for a record.

EDSTest::testGetFTCustomLinks() — Method in class EDSTest

Test getFTCustomLinks for a record.

EDSTest::testGetDbLabel() — Method in class EDSTest

Test getDbLabel for a record.

EDSTest::testGetHTMLFullText() — Method in class EDSTest

Test getHTMLFullText for a record.

EDSTest::testHasHTMLFullTextAvailable() — Method in class EDSTest

Test hasHTMLFullTextAvailable for a record.

EDSTest::testGetItems() — Method in class EDSTest

Test getItems for a record.

EDSTest::testGetPLink() — Method in class EDSTest

Test getPLink for a record.

EDSTest::testGetPubType() — Method in class EDSTest

Test getPubType for a record.

EDSTest::testGetPubTypeId() — Method in class EDSTest

Test getPubTypeId for a record.

EDSTest::testHasPdfAvailable() — Method in class EDSTest

Test hasPdfAvailable for a record.

EDSTest::testGetPdfLink() — Method in class EDSTest

Test getPdfLink for a record.

EDSTest::testGetItemsSubjects() — Method in class EDSTest

Test getItemsSubjects for a record.

EDSTest::testGetThumbnail() — Method in class EDSTest

Test getThumbnail for a record.

EDSTest::testGetItemsTitle() — Method in class EDSTest

Test getItemsTitle for a record.

EDSTest::testGetTitle() — Method in class EDSTest

Test getTitle for a record.

EDSTest::testGetPrimaryAuthors() — Method in class EDSTest

Test getPrimaryAuthors for a record.

EDSTest::testGetItemsTitleSource() — Method in class EDSTest

Test getItemsTitleSource for a record.

EDSTest::testLinkUrls() — Method in class EDSTest

Test linkUrls for a record.

EDSTest::testGetISSNs() — Method in class EDSTest

Test getISSNs.

EDSTest::testGetISBNs() — Method in class EDSTest

Test getISBNs.

EITTest::testGetAllSubjectHeadings() — Method in class EITTest

Test getAllSubjectHeadings for a record.

EITTest::testGetBreadcrumb() — Method in class EITTest

Test getBreadcrumb for a record.

EITTest::testGetCleanISSN() — Method in class EITTest

Test getCleanISSN for a record.

EITTest::testGetFormats() — Method in class EITTest

Test getFormats for a record.

EITTest::testGetPrimaryAuthors() — Method in class EITTest

Test getPrimaryAuthors for a record.

EITTest::testGetPublicationDates() — Method in class EITTest

Test getPublicationDates for a record.

EITTest::testGetPublishers() — Method in class EITTest

Test getPublishers for a record.

MarcAdvancedTraitTest::testMarcAdvancedTrait() — Method in class MarcAdvancedTraitTest

Test methods in MarcAdvancedTrait.

MarcAdvancedTraitTest::testMissingISMN() — Method in class MarcAdvancedTraitTest

Test missing ISMN case.

MarcAdvancedTraitTest::testMarcAdvancedTraitAltScript() — Method in class MarcAdvancedTraitTest

Test alternative script methods in MarcAdvancedTrait.

MarcBasicTraitTest::testMarcBasicTrait() — Method in class MarcBasicTraitTest

Test methods in MarcBasicTrait.

MarcBasicTraitTest::testMarcBasicTraitMissingFields() — Method in class MarcBasicTraitTest

Test methods in MarcBasicTrait with missing fields.

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

PublicationDetailsTest::testGetters() — Method in class PublicationDetailsTest

Test getters

PublicationDetailsTest::testToString() — Method in class PublicationDetailsTest

Test __toString

SolrAuthMarcTest::testRawLCCN() — Method in class SolrAuthMarcTest

Test LCCN support.

SolrDefaultTest::testBookOpenURL() — Method in class SolrDefaultTest

Test an OpenURL for a book.

SolrDefaultTest::testGetSnippetCaption() — Method in class SolrDefaultTest

Test a snippet caption.

SolrDefaultTest::testArticleOpenURL() — Method in class SolrDefaultTest

Test an OpenURL for an article.

SolrDefaultTest::testJournalOpenURL() — Method in class SolrDefaultTest

Test an OpenURL for a journal.

SolrDefaultTest::testUnknownTypeOpenURL() — Method in class SolrDefaultTest

Test an OpenURL for an unknown material type.

SolrDefaultTest::testDublinCore() — Method in class SolrDefaultTest

Test Dublin Core conversion.

SolrDefaultTest::testGetContainerRecordID() — Method in class SolrDefaultTest

Test getContainerRecordID for a record.

SolrDefaultTest::testGetChildRecordCount() — Method in class SolrDefaultTest

Test getChildRecordCount for a record.

SolrDefaultTest::testGetHighlightedTitle() — Method in class SolrDefaultTest

Test getHighlightedTitle for a record.

SolrDefaultTest::testGetHighlightedSnippet() — Method in class SolrDefaultTest

Test getHighlightedSnippet for a record.

SolrDefaultTest::testHighlightDetails() — Method in class SolrDefaultTest

Test HighlightDetails for a record.

SolrDefaultTest::testGetRawAuthorHighlights() — Method in class SolrDefaultTest

Test getRawAuthorHighlights for a record.

SolrMarcRemoteTest::testRequiredConfigException() — Method in class SolrMarcRemoteTest

Test config validation.

SolrMarcRemoteTest::testMissingRecordId() — Method in class SolrMarcRemoteTest

Test record ID validation (a record with no ID cannot be resolved).

SolrMarcRemoteTest::testRecordRetrieval() — Method in class SolrMarcRemoteTest

Test actually retrieving a record.

SolrMarcTest::testBug1() — Method in class SolrMarcTest

Test a record that used to be known to cause problems because of the way its linking fields are set up.

SolrMarcTest::testBug2() — Method in class SolrMarcTest

Test a record that used to be known to cause problems because of the way series name was handled (the old "Bug2" test from VuFind 1.x).

SolrMarcTest::testSubjectHeadings() — Method in class SolrMarcTest

Test regular and extended subject heading support.

SolrMarcTest::testTOC() — Method in class SolrMarcTest

Test table of contents support.

SolrMarcTest::testGetFormattedMarcDetails() — Method in class SolrMarcTest

Test getFormattedMarcDetails() method.

SolrMarcTest::testMarcReaderTrait() — Method in class SolrMarcTest

Test methods in MarcReaderTrait.

SolrOverdriveTest::testSupportsOpenUrl() — Method in class SolrOverdriveTest

Test supportsOpenUrl()

SolrOverdriveTest::testGetOverdriveIDWithMarc() — Method in class SolrOverdriveTest

Test getOverdriveID in MARC mode

SolrOverdriveTest::testGetOverdriveIDWithoutMarc() — Method in class SolrOverdriveTest

Test getOverdriveID in non-MARC mode

SolrOverdriveTest::testGetBreadcrumb() — Method in class SolrOverdriveTest

Test getBreadcrumb()

SolrOverdriveTest::testGetThumbnailNoMarc() — Method in class SolrOverdriveTest

Test getThumbnail without MARC

SolrOverdriveTest::testGetTitleSection() — Method in class SolrOverdriveTest

Test getTitleSection()

SolrOverdriveTest::testGetGeneralNotes() — Method in class SolrOverdriveTest

Test getGeneralNotes()

SolrOverdriveTest::testGetSummaryMarc() — Method in class SolrOverdriveTest

Test getSummary() with MARC

SolrOverdriveTest::testGetSummaryNonMarc() — Method in class SolrOverdriveTest

Test getSummary() without MARC

SolrOverdriveTest::testGetAllSubjectHeadingsMarc() — Method in class SolrOverdriveTest

Test getAllSubjectHeadings() with MARC

SolrOverdriveTest::testGetAllSubjectHeadingsNonMarc() — Method in class SolrOverdriveTest

Test getAllSubjectHeadings() without MARC

SolrOverdriveTest::testGetRawDataMarc() — Method in class SolrOverdriveTest

Test getRawData behavior in MARC mode

SolrOverdriveTest::testGetRawDataNonMarc() — Method in class SolrOverdriveTest

Test getRawData behavior in non-MARC mode

TestHarnessClass in namespace VuFindTest\RecordDriver

Test harness for simulating record drivers (ignore outside of test suite!)

WorldCatTest::testSetRawData() — Method in class WorldCatTest

Test that we can setRawData() with getRawData() without breaking anything.

CollectionHierarchyTreeTest::testGetActiveRecord() — Method in class CollectionHierarchyTreeTest

Test that getActiveRecord loads the correct record ID.

CollectionHierarchyTreeTest::testGetActiveRecordWithEmptyId() — Method in class CollectionHierarchyTreeTest

Test that getActiveRecord returns false when no ID parameter is provided.

ComponentPartsTest::testGetDescription() — Method in class ComponentPartsTest

Test getting Description.

ComponentPartsTest::testGetMaxResults() — Method in class ComponentPartsTest

Test Maxresults.

ComponentPartsTest::testIsActive() — Method in class ComponentPartsTest

Test if the tab is active.

ComponentPartsTest::testGetResults() — Method in class ComponentPartsTest

Test getting contents for display.

DescriptionTest::testGetDescription() — Method in class DescriptionTest

Test getting Description.

ExcerptTest::testGetDescription() — Method in class ExcerptTest

Test getting Description.

FormatsTest::testGetDescription() — Method in class FormatsTest

Test getting Description.

FormatsTest::testisActive() — Method in class FormatsTest

Test if the tab is active.

HoldingsILSTest::testGetUniqueCallNumbers() — Method in class HoldingsILSTest

Test getUniqueCallNumbers.

HoldingsWorldCatTest::testGetDescription() — Method in class HoldingsWorldCatTest

Test getting Description.

HoldingsWorldCatTest::testIsActive() — Method in class HoldingsWorldCatTest

Test if the tab is active.

HoldingsWorldCatTest::testGetHoldings() — Method in class HoldingsWorldCatTest

Test getting holdings information.

MapTest::testGetDescription() — Method in class MapTest

Test getting Description.

MapTest::testSupportsAjax() — Method in class MapTest

Test if the tab loaded via AJAX.

MapTest::testGetMapGraticule() — Method in class MapTest

Test getting Graticule.

MapTest::testGetBasemap() — Method in class MapTest

Test getting basemap Configuration.

MapTest::testIsActive() — Method in class MapTest

Test if the tab is Active.

MapTest::testGetDisplayCoords() — Method in class MapTest

Test get map display coordinates.

MapTest::testGetGeoLocationCoords() — Method in class MapTest

Test geo-location coordinates.

MapTest::testGetMapTabData() — Method in class MapTest

Test construction of map-coordinates adn labels.

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

PreviewTest::testGetDescription() — Method in class PreviewTest

Test getting Description.

PreviewTest::testisActive() — Method in class PreviewTest

Test if the tab is active.

PreviewTest::testisVisible() — Method in class PreviewTest

Test if the tab is initially visible.

PreviewTest::testsupportsAjax() — Method in class PreviewTest

Test if the tab can be loaded via AJAX.

ReviewsTest::testGetDescription() — Method in class ReviewsTest

Test getting Description.

SimilarItemsCarouselTest::testGetDescription() — Method in class SimilarItemsCarouselTest

Test getting Description.

SimilarItemsCarouselTest::testGetResults() — Method in class SimilarItemsCarouselTest

Test getting results.

StaffViewArrayTest::testGetDescription() — Method in class StaffViewArrayTest

Test getting Description.

StaffViewMARCTest::testGetDescription() — Method in class StaffViewMARCTest

Test getting Description.

StaffViewOverdriveTest::testGetDescription() — Method in class StaffViewOverdriveTest

Test getting Description.

TOCTestClass in namespace VuFindTest\RecordTab

TOC Test Class

TOCTest::testGetDescription() — Method in class TOCTest

Test getting Description.

TOCTest::testIsActive() — Method in class TOCTest

Test if the tab is active.

TabManagerTestClass in namespace VuFindTest\RecordTab

RecordTab Manager Test Class

TabManagerTest::testGetTabDetailsForRecord() — Method in class TabManagerTest

Test that we get the expected tab service names.

TabManagerTest::testGetBackgroundTabNames() — Method in class TabManagerTest

Test getBackgroundTabNames.

UserCommentsTest::testGetDescription() — Method in class UserCommentsTest

Test getting Description.

UserCommentsTest::testIsActive() — Method in class UserCommentsTest

Test if the tab is active.

UserCommentsTest::testIsCaptchaActive() — Method in class UserCommentsTest

Test if the Captcha is Active.

VersionsTest::testGetDescription() — Method in class VersionsTest

Test getting Description.

VersionsTest::testisActive() — Method in class VersionsTest

Test if the tab is active.

CacheTest::testLookup() — Method in class CacheTest

Test lookup

CacheTest::testLookupBatch() — Method in class CacheTest

Test lookupBatch

CacheTest::testIsFallback() — Method in class CacheTest

Test isFallback

CacheTest::testIsPrimary() — Method in class CacheTest

Test isPrimary

CacheTest::testIsCachable() — Method in class CacheTest

Test IsCachable

CacheTest::testSetContext() — Method in class CacheTest

Test setContext

CacheTest::testCreateOrUpdate() — Method in class CacheTest

Test createOrUpdate

ChecklistTest::testChecklist() — Method in class ChecklistTest

Test checklists

SolrTest::testEnabledLoader() — Method in class SolrTest

Test that the fallback loader works when enabled (default settings).

SolrTest::testDisabledLoader() — Method in class SolrTest

Test that the fallback loader can be disabled.

SummonTest::testLoader() — Method in class SummonTest

Test the fallback loader.

LoaderTest::testMissingRecord() — Method in class LoaderTest

Test exception for missing record.

LoaderTest::testMissingRecordWithFallback() — Method in class LoaderTest

Test that the fallback loader gets called successfully for a missing record.

LoaderTest::testToleratedMissingRecord() — Method in class LoaderTest

Test "tolerate missing records" feature.

LoaderTest::testSingleRecord() — Method in class LoaderTest

Test single record.

LoaderTest::testSingleRecordWithBackendParameters() — Method in class LoaderTest

Test single record with backend parameters.

LoaderTest::testBatchLoad() — Method in class LoaderTest

Test batch load.

LoaderTest::testBatchLoadWithFallback() — Method in class LoaderTest

Test batch load with fallback loader.

RouterTest::testRoutingWithDriver() — Method in class RouterTest

Test routing with driver object.

RouterTest::testRoutingWithString() — Method in class RouterTest

Test routing with source|id string.

RouterTest::testTabRoutingWithString() — Method in class RouterTest

Test tab routing with source|id string.

RouterTest::testCollectionSpecialCaseWithString() — Method in class RouterTest

Test collection special case with source|id string.

RouterTest::testRoutingWithIDContainingPercent() — Method in class RouterTest

Test routing with source|id string including percent signs.

RouterTest::testCollectionSpecialCaseWithStringMissingSource() — Method in class RouterTest

Test collection special case with id string having no source prefix.

RouterTest::testCollectionSpecialCaseWithDriver() — Method in class RouterTest

Test collection special case with driver.

RouterTest::testRoutingWithStringMissingSource() — Method in class RouterTest

Test routing with id string having no source prefix.

RouterTest::testActionRoutingWithDriver() — Method in class RouterTest

Test action routing with driver object.

SourceAndIdListTest::testListNormalization() — Method in class SourceAndIdListTest

Test normalization -- regardless of how the data is sent in, the result should be the same.

SourceAndIdListTest::testRegularRetrieve() — Method in class SourceAndIdListTest

Test retrieving the position of a regular record from the list.

SourceAndIdListTest::testChangedRecordId() — Method in class SourceAndIdListTest

Test retrieving the position of a record with a changed ID from the list.

SourceAndIdListTest::testRepeatingRecord() — Method in class SourceAndIdListTest

Test retrieving the positions of a record that appears in the list repeatedly.

SourceAndIdListTest::testSourceRequired() — Method in class SourceAndIdListTest

Test that source has to be matched to retrieve a record.

BookplateTest::testDefaultsWithNoConfig() — Method in class BookplateTest

Test default behavior (no bookplates)

BookplateTest::testBookplateWithDefaultConfigLocation() — Method in class BookplateTest

Test bookplate display with default config location, title display on, and single-valued index fields.

BookplateTest::testBookplateWithNonDefaultConfigLocation() — Method in class BookplateTest

Test bookplate display with non-default config location, title display off, and multi-valued index fields.

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

SimilarTest::testGetResults() — Method in class SimilarTest

Test results.

WorldCatSimilarTest::testGetResults() — Method in class WorldCatSimilarTest

Test results.

CsvReaderTest::testGetInstructors() — Method in class CsvReaderTest

Test getInstructors()

CsvReaderTest::testGetCourses() — Method in class CsvReaderTest

Test getCourses()

CsvReaderTest::testGetDepartments() — Method in class CsvReaderTest

Test getDepartments()

CsvReaderTest::testGetReserves() — Method in class CsvReaderTest

Test getReserves()

CsvReaderTest::testGetErrors() — Method in class CsvReaderTest

Test getErrors()

CsvReaderTest::testEmptyFile() — Method in class CsvReaderTest

Test loading an empty file.

AlmaTest::testParseLinks() — Method in class AlmaTest
Test
AlmaTest::testParseLinksWithoutIgnoredFiltering() — Method in class AlmaTest

Test link parser without ignored filters

JopTest::testParseLinks() — Method in class JopTest

Test link parsing

JopTest::testGetResolverUrl() — Method in class JopTest

Test URL generation

JopTest::testDowngradeOpenUrl() — Method in class JopTest

Test implicit downgrade of open url

JopTest::testDowngradeOpenUrlWithoutMappingKey() — Method in class JopTest

Test implicit call of downgradeOpenUrl

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

RediTest::testParseLinks() — Method in class RediTest
Test
SimpleRecordTest::testDefaultSourceId() — Method in class SimpleRecordTest

Test for expected default source ID.

SimpleRecordTest::testSetSourceId() — Method in class SimpleRecordTest

Test that we can change default source ID.

SimpleRecordTest::testGetFields() — Method in class SimpleRecordTest

Test retrieving data fields.

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

DynamicRoleProviderTest::testConfiguration() — Method in class DynamicRoleProviderTest

Test that configurations get processed correctly

PermissionDeniedManagerTest::testTemplateConfig() — Method in class PermissionDeniedManagerTest

Test a correctly configured template

PermissionDeniedManagerTest::testExceptionConfig() — Method in class PermissionDeniedManagerTest

Test a correctly configured exception

PermissionDeniedManagerTest::testEmptyConfig() — Method in class PermissionDeniedManagerTest

Test an empty permission section getDeniedControllerBehavior should return false as the PermissionDeniedManager has nothing to do

PermissionDeniedManagerTest::testNonExistentConfig() — Method in class PermissionDeniedManagerTest

Test a non existent permission section getDeniedControllerBehavior should return false as the PermissionDeniedManager has nothing to do

PermissionManagerTest::testNonExistentPermission() — Method in class PermissionManagerTest

Test a non existent permission section

PermissionManagerTest::testExistentPermission() — Method in class PermissionManagerTest

Test an existing permission section

PermissionManagerTest::testExistentPermissionInArray() — Method in class PermissionManagerTest

Test an existing permission section in an array

PermissionManagerTest::testGrantedPermission() — Method in class PermissionManagerTest

Test a granted permission

PermissionManagerTest::testDeniedPermission() — Method in class PermissionManagerTest

Test a denied permission

IpRangeTest::testMatchingRange() — Method in class IpRangeTest

Test a matching range.

IpRangeTest::testNonMatchingRegExArray() — Method in class IpRangeTest

Test an array of non-matching ranges.

IpRegExTest::testMatchingRegEx() — Method in class IpRegExTest

Test a matching regular expression.

IpRegExTest::testNonMatchingRegExArray() — Method in class IpRegExTest

Test an array of non-matching regular expressions.

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

ServerParamTest::testStringTrue() — Method in class ServerParamTest

Test single option with matching string

ServerParamTest::testArrayTrue() — Method in class ServerParamTest

Test option array with matching string

ServerParamTest::testOptionsAndTrue() — Method in class ServerParamTest

Test multiple options with matching headers

ServerParamTest::testOptionsAndFalse() — Method in class ServerParamTest

Test multiple options with no matching header

ServerParamTest::testOptionValuesOrTrue() — Method in class ServerParamTest

Test option with multiple values and matching header

ServerParamTest::testOptionValuesOrFalse() — Method in class ServerParamTest

Test option with multiple values and no matching header

ServerParamTest::testOptionRegexTrue() — Method in class ServerParamTest

Test option with regex modifier and matching header

ServerParamTest::testOptionRegexFalse() — Method in class ServerParamTest

Test option with regex modifier and no matching header

ServerParamTest::testOptionNotTrue() — Method in class ServerParamTest

Test option with not modifier and matching header

ServerParamTest::testOptionNotFalse() — Method in class ServerParamTest

Test option with not modifier and no matching header

ServerParamTest::testOptionNotRegexTrue() — Method in class ServerParamTest

Test option with not regex modifier and matching header

ServerParamTest::testOptionNotRegexFalse() — Method in class ServerParamTest

Test option with not regex modifier and no matching header

ShibbolethTest::testAliasIdpentityidTrue() — Method in class ShibbolethTest

Test option alias idpentityid for Shib-Identity-Provider

ShibbolethTest::testMultivaluedOptionTrue() — Method in class ShibbolethTest

Test multi-valued option with matching header

ShibbolethTest::testMultivaluedOptionFalse() — Method in class ShibbolethTest

Test multi-valued option with matching no header

$ UserTest#testuserProperty in class UserTest

Current test user

UserTest::testGetPermissions() — Method in class UserTest

Test single option with matching string

UserTest::testBadConfig() — Method in class UserTest

Test an invalid configuration

RouteGeneratorTest::testAddDynamicRoutes() — Method in class RouteGeneratorTest

Test addDynamicRoutes()

RouteGeneratorTest::testAddStaticRoutes() — Method in class RouteGeneratorTest

Test addStaticRoutes()

RouteGeneratorTest::testAddRecordRoutes() — Method in class RouteGeneratorTest

Test addRecordRoutes()

RouteGeneratorTest::testAddRecordRoutesWithSubclass() — Method in class RouteGeneratorTest

Test addRecordRoutes() using a subclass

ClickatellTest::testCarriers() — Method in class ClickatellTest

Test carrier list

ClickatellTest::testSuccessResponse() — Method in class ClickatellTest

Test successful query

ClickatellTest::testUnexpectedResponse() — Method in class ClickatellTest

Test unexpected response

ClickatellTest::testFailureResponse() — Method in class ClickatellTest

Test unsuccessful query

ClickatellTest::testClientException() — Method in class ClickatellTest

Test an exception in the mail client

SearchServiceTest::testInvoke() — Method in class SearchServiceTest

Test invoke action.

SearchServiceTest::testInvokeException() — Method in class SearchServiceTest

Test exception-throwing invoke action.

SearchServiceTest::testFailedResolveWithCommand() — Method in class SearchServiceTest

Test a failure to resolve using a command object.

BackendManagerTest::testGetThrowsOnNonObject() — Method in class BackendManagerTest

Test that get() throws on a non-object.

BackendManagerTest::testGetThrowsOnNonBackend() — Method in class BackendManagerTest

Test that get() throws on a non-backend.

BackendManagerTest::testAttachDetachShared() — Method in class BackendManagerTest

Test attaching to and detaching from shared event manager.

HideFacetValueListenerTest::testAttach() — Method in class HideFacetValueListenerTest

Test attaching listener.

HideFacetValueListenerTest::testHideFacet() — Method in class HideFacetValueListenerTest

Test actual functionality of listener, with "hide facet" setting.

HideFacetValueListenerTest::testShowFacets() — Method in class HideFacetValueListenerTest

Test actual functionality of listener, with "show facets" setting.

HideFacetValueListenerTest::testHideFacetsAndShowFacets() — Method in class HideFacetValueListenerTest

Test actual functionality of listener, with "hide facets" and "show facets" settings, demonstrating that both can be applied together (though doing so in a real-world scenario would not really make sense).

ParamsTest::testGetCheckboxFacets() — Method in class ParamsTest

Test that getCheckboxFacets works as expected.

ParamsTest::testFilters() — Method in class ParamsTest

Test that filters work as expected.

ParamsTest::testGetFacetLabel() — Method in class ParamsTest

Test that getFacetLabel works as expected.

ParamsTest::testGetFacetLabelWithAliases() — Method in class ParamsTest

Test that getFacetLabel works as expected with aliases.

ParamsTest::testGetSearchClassId() — Method in class ParamsTest

Test that we get a mock search class ID while testing.

ParamsTest::testSpellingReplacements() — Method in class ParamsTest

Test that spelling replacement works as expected.

OptionsTest::testOptions() — Method in class OptionsTest

Test that the Options object returns correct data.

ParamsTest::testGetSearchClassId() — Method in class ParamsTest

Test that we get the correct search class ID.

ParamsTest::testFacetsAndFilters() — Method in class ParamsTest

Test that facets and filters work as expected.

ParamsTest::testHiddenFilters() — Method in class ParamsTest

Test that hidden filters work as expected.

ParamsTest::testBlenderFilters() — Method in class ParamsTest

Test that special blender_backend filters work as expected.

ParamsTest::testBlenderFacets() — Method in class ParamsTest

Test that special blender_backend checkbox facets work as expected.

ParamsTest::testIgnoredFilters() — Method in class ParamsTest

Test that ignoring filters works as expected.

ParamsTest::testGetFacetLabel() — Method in class ParamsTest

Test that getFacetLabel works as expected.

ParamsTest::testFacetMappings() — Method in class ParamsTest

Test that facet mappings work as expected.

ParamsTest::testSearchTypeMappings() — Method in class ParamsTest

Test that search type mappings work as expected.

ParamsTest::testSortMappings() — Method in class ParamsTest

Test that sort mappings work as expected.

ParamsTest::testInitFromRequest() — Method in class ParamsTest

Test that initFromRequest works as expected.

ParamsTest::testInvalidBackend() — Method in class ParamsTest

Test that an invalid backend in configuration is handled properly.

ResultsTest::testPerformSearch() — Method in class ResultsTest
ParamsTest::testDynamicCheckboxes() — Method in class ParamsTest

Test that checkbox filters are always visible (or not) as appropriate.

HistoryTest::testDefaultDisabledScheduleOptions() — Method in class HistoryTest

Test that we get no schedule options when scheduled search is disabled (by default).

HistoryTest::testExplicitlyDisabledScheduleOptions() — Method in class HistoryTest

Test that we get no schedule options when scheduled search is disabled (explicitly).

HistoryTest::testDefaultScheduleOptions() — Method in class HistoryTest

Test that we get reasonable default schedule options when scheduled search is enabled.

HistoryTest::testSingleNonDefaultScheduleOption() — Method in class HistoryTest

Test a single non-default schedule option.

HistoryTest::testMultipleNonDefaultScheduleOptions() — Method in class HistoryTest

Test multiple non-default schedule options.

HistoryTest::testPurgeHistory() — Method in class HistoryTest

Test that purging history proxies to the right place.

MemoryTest::testBasicMemory() — Method in class MemoryTest

Test basic memory.

MemoryTest::testForgetting() — Method in class MemoryTest

Test forgetting.

MemoryTest::testEmptyURL() — Method in class MemoryTest

Test setting an empty URL.

MemoryTest::testDisable() — Method in class MemoryTest

Test disabling the memory.

NormalizedSearchTest::testGetRawResults() — Method in class NormalizedSearchTest

Test getRawResults.

NormalizedSearchTest::testGetMinified() — Method in class NormalizedSearchTest

Test getMinified.

NormalizedSearchTest::testGetNormalizedResults() — Method in class NormalizedSearchTest

Test getNormalizedResults.

NormalizedSearchTest::testGetUrl() — Method in class NormalizedSearchTest

Test getUrl.

NormalizedSearchTest::testGetChecksum() — Method in class NormalizedSearchTest

Test getChecksum.

NormalizedSearchTest::testEquivalentSearches() — Method in class NormalizedSearchTest

Test positive equivalence.

NormalizedSearchTest::testNonEquivalentSearches() — Method in class NormalizedSearchTest

Test negative equivalence.

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

OnCampusListenerTest::testAttach() — Method in class OnCampusListenerTest

Test attaching listener.

OnCampusListenerTest::testAttachWithParameter() — Method in class OnCampusListenerTest

Test attaching listener with parameter.

OnCampusListenerTest::testOnCampusWithoutAuthorizationService() — Method in class OnCampusListenerTest

Test the listener without setting an authorization service.

OnCampusListenerTest::testOnCampusDefaultSuccessfull() — Method in class OnCampusListenerTest

Test the listener if default permission rule applies

OnCampusListenerTest::testOnCampusDefaultNotSuccessfull() — Method in class OnCampusListenerTest

Test the listener if default permission rule applies and default permission is not enough to get Primo results

OnCampusListenerTest::testOnCampusInsideNetwork() — Method in class OnCampusListenerTest

Test the listener if certain rule applies (user is inside a configured network)

OnCampusListenerTest::testOnCampusOutsideNetwork() — Method in class OnCampusListenerTest

Test the listener if certain rule applies (user is outside of any configured network)

OnCampusListenerTest::testOnCampusNoPermissionController() — Method in class OnCampusListenerTest

Test the listener if no permission controller exists

ParamsTest::testFixPrimoFacetValue() — Method in class ParamsTest

Test facet value normalization

ParamsTest::testFilters() — Method in class ParamsTest

Test that filters work as expected.

ParamsTest::testGetSearchClassId() — Method in class ParamsTest

Test that we get a mock search class ID while testing.

PrimoPermissionHandlerTest::testWithoutConfig() — Method in class PrimoPermissionHandlerTest

Test the handler without configuration.

PrimoPermissionHandlerTest::testWithoutAuthorizationService() — Method in class PrimoPermissionHandlerTest

Test the handler without setting an authorization service.

PrimoPermissionHandlerTest::testWithoutAuthorizationServiceWithLaminasConfigObject() — Method in class PrimoPermissionHandlerTest

Test the handler without setting an authorization service.

PrimoPermissionHandlerTest::testHandlerCodeSuccessfull() — Method in class PrimoPermissionHandlerTest

Test the handler code if permission matches This should return the actual institution code (depending on config)

PrimoPermissionHandlerTest::testHandlerDefaultCode() — Method in class PrimoPermissionHandlerTest

Test the handler if permission does not match This should return the default institution code (if this is configured, for this test it is configured)

PrimoPermissionHandlerTest::testSetInstCode() — Method in class PrimoPermissionHandlerTest

Test the institution code setter

PrimoPermissionHandlerTest::testHandlerMemberAuthSuccessfull() — Method in class PrimoPermissionHandlerTest

Test the handler if permission via member code matches

PrimoPermissionHandlerTest::testHandlerMemberAuthNotSuccessfull() — Method in class PrimoPermissionHandlerTest

Test the handler if permission (member and deafult) does not match

PrimoPermissionHandlerTest::testHandlerDefaultAuthSuccessfull() — Method in class PrimoPermissionHandlerTest

Test the handler if permission does not match

PrimoPermissionHandlerTest::testHandlerDefaultAuthNotSuccessfull() — Method in class PrimoPermissionHandlerTest

Test the handler if permission does not match

PrimoPermissionHandlerTest::testAuthNotExisting() — Method in class PrimoPermissionHandlerTest

Test the handler if permission does not exist

PrimoPermissionHandlerTest::testHandlerWithoutDefaultAuthSuccessfull() — Method in class PrimoPermissionHandlerTest

Test the handler if permission matches

PrimoPermissionHandlerTest::testHandlerWithoutDefaultAuthNotSuccessfull() — Method in class PrimoPermissionHandlerTest

Test the handler if permission (member and deafult) does not match

PrimoPermissionHandlerTest::testHandlerWithoutDefaultCodeSuccessfull() — Method in class PrimoPermissionHandlerTest

Test the handler code if permission matches

PrimoPermissionHandlerTest::testHandlerWithoutDefaultCodeAuthNotSuccessfull() — Method in class PrimoPermissionHandlerTest

Test the handler if permission does not match This should return the default PrimoInstance code (if this is configured, for this test it is configured)

PrimoPermissionHandlerTest::testHandlerWithoutDefaultDefaultAuthSuccessfull() — Method in class PrimoPermissionHandlerTest

Test the handler if permission does not match

PrimoPermissionHandlerTest::testHandlerWithoutDefaultDefaultAuthNotSuccessfull() — Method in class PrimoPermissionHandlerTest

Test the handler if permission does not match

PrimoPermissionHandlerTest::testHandlerDefaultOnlyAuthNotSuccessfull() — Method in class PrimoPermissionHandlerTest

Test the handler if permission (member and deafult) does not match

PrimoPermissionHandlerTest::testHandlerDefaultOnlyCodeAuthNotSuccessfull() — Method in class PrimoPermissionHandlerTest

Test the handler if permission does not match This should return the default PrimoInstance code (if this is configured, for this test it is configured)

PrimoPermissionHandlerTest::testHandlerDefaultOnlyDefaultAuthSuccessfull() — Method in class PrimoPermissionHandlerTest

Test the handler if permission does not match

PrimoPermissionHandlerTest::testHandlerDefaultOnlyDefaultAuthNotSuccessfull() — Method in class PrimoPermissionHandlerTest

Test the handler if permission does not match

PrimoPermissionHandlerTest::testHandlerMemberIsOnCampusWithDefault() — Method in class PrimoPermissionHandlerTest

Test the handler if permission (member and default) does not match

PrimoPermissionHandlerTest::testHandlerMemberIsNotOnCampusWithDefault() — Method in class PrimoPermissionHandlerTest

Test the handler if permission does not match This should return the default PrimoInstance code (if this is configured, for this test it is configured)

PrimoPermissionHandlerTest::testHandlerIsNotAMemberAndNotDefaultOnCampus() — Method in class PrimoPermissionHandlerTest

Test the handler if permission does not match

PrimoPermissionHandlerTest::testHandlerIsNotAMemberButOnDefaultCampus() — Method in class PrimoPermissionHandlerTest

Test the handler if permission does not exist

PrimoPermissionHandlerTest::testHandlerMemberIsOnCampus() — Method in class PrimoPermissionHandlerTest

Test the handler if permission (member and deafult) does not match

PrimoPermissionHandlerTest::testHandlerMemberIsNotOnCampus() — Method in class PrimoPermissionHandlerTest

Test the handler if permission does not match This should return the default PrimoInstance code (if this is configured, for this test it is configured)

PrimoPermissionHandlerTest::testHandlerIsNotAMember() — Method in class PrimoPermissionHandlerTest

Test the handler if permission does not match

PrimoPermissionHandlerTest::testHandlerDefaultOnlyNoOncampus() — Method in class PrimoPermissionHandlerTest

Permission cannot be granted without an onCampusRule

PrimoPermissionHandlerTest::testHandlerDefaultOnlyCodeNoOncampus() — Method in class PrimoPermissionHandlerTest

Test the handler if permission does not match This should return the default PrimoInstance code (if this is configured, for this test it is configured)

QueryAdapterTest::testConversions() — Method in class QueryAdapterTest

Test various conversions.

QueryAdapterTest::testOperatorDefinedEverywhere() — Method in class QueryAdapterTest

Test that when one part of the query contains an operator, ALL parts of the query contain an operator. (We want to be sure that in cases where the first part of the query has no operator associated with it, a blank value is filled in as a placeholder.

QueryAdapterTest::testAdvancedRequest() — Method in class QueryAdapterTest

Test building an advanced query from a request.

QueryAdapterTest::testEmptyRequest() — Method in class QueryAdapterTest

Test building an advanced query from an empty request.

QueryAdapterTest::testDisplay() — Method in class QueryAdapterTest

Test display capabilities.

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

SearchNormalizerTest::testNormalizeMinifiedSearch() — Method in class SearchNormalizerTest

Test normalizeMinifiedSearch(), which will also cover normalizeSearch().

$ SearchTabsHelperTest#tabConfigProperty in class SearchTabsHelperTest
SearchTabsHelperTest::testGetHiddenFilters() — Method in class SearchTabsHelperTest

Test getHiddenFilters()

SearchTabsHelperTest::testTabConfig() — Method in class SearchTabsHelperTest

Test getTabConfig() and getTabFilterConfig()

SearchTabsHelperTest::testExtractClassName() — Method in class SearchTabsHelperTest

Test extractClassName()

SearchTabsHelperTest::testFiltersMatch() — Method in class SearchTabsHelperTest

Test filtersMatch()

ConditionalFilterListenerTest::testAttach() — Method in class ConditionalFilterListenerTest

Test attaching listener.

ConditionalFilterListenerTest::testConditionalFilterWithoutAuthorizationService() — Method in class ConditionalFilterListenerTest

Test the listener without setting an authorization service.

ConditionalFilterListenerTest::testConditionalFilterWithoutAuthorizationServiceWithParams() — Method in class ConditionalFilterListenerTest

Test the listener without setting an authorization service, but with fq-parameters.

ConditionalFilterListenerTest::testConditionalFilterEmptyConfig() — Method in class ConditionalFilterListenerTest

Test the listener with an empty conditional filter config.

ConditionalFilterListenerTest::testConditionalFilterEmptyConfigWithFQ() — Method in class ConditionalFilterListenerTest

Test the listener with an empty conditional filter config, but with given fq parameters

ConditionalFilterListenerTest::testConditionalFilter() — Method in class ConditionalFilterListenerTest

Test the listener without preset fq parameters if the conditional filter is granted

ConditionalFilterListenerTest::testNegativeConditionalFilter() — Method in class ConditionalFilterListenerTest

Test the listener without preset fq parameters if the conditional filter is not granted

ConditionalFilterListenerTest::testNegativeConditionalFilterWithFQ() — Method in class ConditionalFilterListenerTest

Test the listener with preset fq-parameters if the conditional filter is not granted

ConditionalFilterListenerTest::testConditionalFilterWithFQ() — Method in class ConditionalFilterListenerTest

Test the listener with preset fq-parameters if the conditional filter is granted

CustomFilterListenerTest::testAttach() — Method in class CustomFilterListenerTest

Test attaching listener.

CustomFilterListenerTest::testRemapping() — Method in class CustomFilterListenerTest

Test remapping of custom filters.

CustomFilterListenerTest::testMismatchedBackendIsIgnored() — Method in class CustomFilterListenerTest

Test that we don't apply changes to the wrong backend.

CustomFilterListenerTest::testWrongContextIsIgnored() — Method in class CustomFilterListenerTest

Test that we don't apply changes to the wrong context.

CustomFilterListenerTest::testMissingInvertedFilterAddsContent() — Method in class CustomFilterListenerTest

Test inverted filter functionality (part 1) -- if the inverted filter is not set, the filter should be applied.

CustomFilterListenerTest::testInvertedFilterPreventsAdditionOfContent() — Method in class CustomFilterListenerTest

Test inverted filter functionality (part 2) -- if the inverted filter is set, the filter should not be applied.

DefaultParametersListenerTest::testAttach() — Method in class DefaultParametersListenerTest

Test attaching listener.

DefaultParametersListenerTest::testDefaultParametersWithCatchAll() — Method in class DefaultParametersListenerTest

Test the listener with a * catch-all.

DefaultParametersListenerTest::testDefaultParametersWithoutCatchAll() — Method in class DefaultParametersListenerTest

Test the listener without a * catch-all.

FilterFieldConversionListenerTest::testAttach() — Method in class FilterFieldConversionListenerTest

Test attaching listener.

FilterFieldConversionListenerTest::testFilterTranslation() — Method in class FilterFieldConversionListenerTest

Test the listener without setting an authorization service.

HierarchicalFacetHelperTest::testSortFacetListDefault() — Method in class HierarchicalFacetHelperTest

Tests for sortFacetList (default/count sort -- at present these should make no changes to the input data and can thus both be tested in a single test method).

HierarchicalFacetHelperTest::testSortFacetListTopLevelBooleanTrue() — Method in class HierarchicalFacetHelperTest

Tests for sortFacetList (top level only, specified with boolean)

HierarchicalFacetHelperTest::testSortFacetListTopLevelStringConfig() — Method in class HierarchicalFacetHelperTest

Tests for sortFacetList (top level only, specified with string)

HierarchicalFacetHelperTest::testSortFacetListAllLevelsBooleanFalse() — Method in class HierarchicalFacetHelperTest

Tests for sortFacetList (all levels, specified with boolean)

HierarchicalFacetHelperTest::testSortFacetListAllLevelsStringConfig() — Method in class HierarchicalFacetHelperTest

Tests for sortFacetList (all levels, specified with string)

HierarchicalFacetHelperTest::testBuildFacetArray() — Method in class HierarchicalFacetHelperTest

Tests for buildFacetArray

HierarchicalFacetHelperTest::testBuildFacetArrayInvalidValues() — Method in class HierarchicalFacetHelperTest

Tests for buildFacetArray with invalid values

HierarchicalFacetHelperTest::testFlattenFacetHierarchy() — Method in class HierarchicalFacetHelperTest

Tests for flattenFacetHierarchy

HierarchicalFacetHelperTest::testFormatDisplayText() — Method in class HierarchicalFacetHelperTest

Tests for formatDisplayText

HierarchicalFacetHelperTest::testIsDeepestFacetLevel() — Method in class HierarchicalFacetHelperTest

Tests for isDeepestFacetLevel

HierarchicalFacetHelperTest::testGetFilterStringParts() — Method in class HierarchicalFacetHelperTest

Tests for getFilterStringParts

MultiIndexListenerTest::testStripFacetFields() — Method in class MultiIndexListenerTest

Strip fields from a field facet.

MultiIndexListenerTest::testAllShardsUsedForRecordRetrieval() — Method in class MultiIndexListenerTest

Test that loading a record overrides the shard settings.

MultiIndexListenerTest::testAttach() — Method in class MultiIndexListenerTest

Test attaching listener.

MultiIndexListenerTest::testStripSpecsEmptySpecs() — Method in class MultiIndexListenerTest

Apply strip to empty specs.

MultiIndexListenerTest::testStripSpecsNoFieldsToStrip() — Method in class MultiIndexListenerTest

Don't strip anything.

MultiIndexListenerTest::testStripSpecsStrip() — Method in class MultiIndexListenerTest

Strip specs.

MultiIndexListenerTest::testStripSpecsAllQueryFields() — Method in class MultiIndexListenerTest

Strip an entire QueryFields section.

OptionsTest::testGetSearchClassId() — Method in class OptionsTest

Test that correct search class ID is reported

OptionsTest::testDefaultSortTieBreaker() — Method in class OptionsTest

Test default sort tie-breaker behavior.

OptionsTest::testSortTieBreakerConfiguration() — Method in class OptionsTest

Test configuration of sort tie-breaker setting.

ParamsTest::testFilters() — Method in class ParamsTest

Test that filters work as expected.

ParamsTest::testGetSearchClassId() — Method in class ParamsTest

Test that we get a mock search class ID while testing.

ParamsTest::testCheckboxVisibility() — Method in class ParamsTest

Test that checkbox filters are always visible (or not) as appropriate.

ParamsTest::testSortTieBreakerParameter() — Method in class ParamsTest

Test sort tie-breaker parameter.

ResultsTest::testCursorMark() — Method in class ResultsTest

Test CursorMark functionality.

ResultsTest::testFacetTranslations() — Method in class ResultsTest

Test facet translation functionality.

ResultsTest::testSpellingProcessor() — Method in class ResultsTest

Test spelling processor support.

ResultsTest::testGetResultTotal() — Method in class ResultsTest

Test retrieving a result count.

ResultsTest::testGetFacetList() — Method in class ResultsTest

Test retrieving facets.

SpellingProcessorTest::testDefaultConfigs() — Method in class SpellingProcessorTest

Test defaults.

SpellingProcessorTest::testNonDefaultConfigs() — Method in class SpellingProcessorTest

Test non-default configs.

SpellingProcessorTest::testSuggestionProcessing() — Method in class SpellingProcessorTest

Test suggestion processing.

SpellingProcessorTest::testSuggestionProcessingWithNonDefaultLimit() — Method in class SpellingProcessorTest

Test suggestion processing.

SpellingProcessorTest::testBasicSuggestions() — Method in class SpellingProcessorTest

Test basic suggestions.

SpellingProcessorTest::testBasicSuggestionsForUppercaseQuery() — Method in class SpellingProcessorTest

Test basic suggestions for an uppercase query.

SpellingProcessorTest::testBasicSuggestionsWithNonDefaultSettings() — Method in class SpellingProcessorTest

Test basic suggestions with expansions disabled and phrase display on.

SpellingProcessorTest::testShingleSuggestion() — Method in class SpellingProcessorTest

Test a shingle suggestion.

SpellingProcessorTest::testAdvancedQuerySuggestions() — Method in class SpellingProcessorTest

Test an advanced search -- this is important because advanced searches sometimes generate false positive phrase suggestions due to the way flattened spelling queries are created; this test exercises the code that fails over to a secondary query when the main query fails to turn up any relevant suggestions.

SpellingProcessorTest::testSpellingTokenization() — Method in class SpellingProcessorTest

Test that spelling tokenization works correctly.

SpellingProcessorTest::testNumericInclusion() — Method in class SpellingProcessorTest

Test inclusion of numeric terms.

SpellingProcessorTest::testNumericExclusion() — Method in class SpellingProcessorTest

Test exclusion of numeric terms.

SpellingProcessorTest::testDetectionOfMissingExtendedResultsSetting() — Method in class SpellingProcessorTest

Test detection of bad Solr response format.

ErrorListenerTest::testDetectParseError() — Method in class ErrorListenerTest

Detect parser error response.

ErrorListenerTest::testDetectUndefinedFieldError() — Method in class ErrorListenerTest

Detect parser error response.

ErrorListenerTest::testDetectParseError() — Method in class ErrorListenerTest

Detect parser error response.

ErrorListenerTest::testDetectUndefinedFieldError() — Method in class ErrorListenerTest

Detect parser error response.

ParamsTest::testCheckboxVisibility() — Method in class ParamsTest

Test that checkbox filters are always visible (or not) as appropriate.

UrlQueryHelperTest::testBasicGetters() — Method in class UrlQueryHelperTest

Test the basic functionality of the helper.

UrlQueryHelperTest::testSetDefaultParameters() — Method in class UrlQueryHelperTest

Test the behavior of setDefaultParameters

UrlQueryHelperTest::testQuerySuppression() — Method in class UrlQueryHelperTest

Test query suppression.

UrlQueryHelperTest::testReplacingQueryTerms() — Method in class UrlQueryHelperTest

Test replacing query terms

UrlQueryHelperTest::testFacetsAndFilters() — Method in class UrlQueryHelperTest

Test adding/removing facets and filters

UrlQueryHelperTest::testStackingSetters() — Method in class UrlQueryHelperTest

Test stacking setters

UrlQueryHelperTest::testAdvancedSearch() — Method in class UrlQueryHelperTest

Test advanced search param building.

UrlQueryHelperTest::testFactory() — Method in class UrlQueryHelperTest

Test that the factory does its job properly.

MarkdownFactoryTest::testConfig() — Method in class MarkdownFactoryTest

Test to ensure the markdown factory is using right config for markdown service

MarkdownFactoryTest::testExtensions() — Method in class MarkdownFactoryTest

Test that extensions are added based on configuration

DatabaseTest::testRead() — Method in class DatabaseTest

Test reading a session from the database.

DatabaseTest::testReadWithNonDefaultLifetime() — Method in class DatabaseTest

Test reading a session from the database with a non-default lifetime config.

DatabaseTest::testGc() — Method in class DatabaseTest

Test garbage collection.

DatabaseTest::testWrite() — Method in class DatabaseTest

Test writing a session.

DatabaseTest::testDestroy() — Method in class DatabaseTest

Test destroying a session.

FileTest::tearDown() — Method in class FileTest

Generic teardown method

FileTest::testWriteReadAndDestroy() — Method in class FileTest

Test the standard default session life cycle.

FileTest::testDisabledWrites() — Method in class FileTest

Test disabling writes.

FileTest::testGarbageCollector() — Method in class FileTest

Test the session garbage collector.

MemcacheTest::testRead() — Method in class MemcacheTest

Test reading a session from the database.

MemcacheTest::testWriteWithDefaults() — Method in class MemcacheTest

Test writing a session with default configs.

MemcacheTest::testWriteWithNonDefaults() — Method in class MemcacheTest

Test writing a session with non-default configs.

MemcacheTest::testDestroy() — Method in class MemcacheTest

Test destroying a session.

MemcacheTest::testReadMemcached() — Method in class MemcacheTest

Test reading a session from the database (Memcached version).

MemcacheTest::testWriteWithDefaultsMemcached() — Method in class MemcacheTest

Test writing a session with default configs (Memcached version).

MemcacheTest::testWriteWithNonDefaultsMemcached() — Method in class MemcacheTest

Test writing a session with non-default configs (Memcached version).

MemcacheTest::testDestroyMemcached() — Method in class MemcacheTest

Test destroying a session (Memcached version).

PluginManagerTest::testShareByDefault() — Method in class PluginManagerTest

Test results.

PluginManagerTest::testExpectedInterface() — Method in class PluginManagerTest

Test expected interface.

RedisTest::testRead() — Method in class RedisTest

Test reading a session from the database.

RedisTest::testWrite() — Method in class RedisTest

Test writing a session with default configs.

RedisTest::testDestroyDefault() — Method in class RedisTest

Test destroying a session with default (Redis version 3) support.

RedisTest::testDestroyNewRedis() — Method in class RedisTest

Test destroying a session with newer (Redis version 4+) support.

SimpleXMLTest::testAppendElement() — Method in class SimpleXMLTest

Test attaching one item to another.

CursorMarkIdFetcherTest::testSetupBackend() — Method in class CursorMarkIdFetcherTest

Test that calling the setupBackend method runs the SetRecordCollectionFactoryCommand.

CursorMarkIdFetcherTest::testFetching() — Method in class CursorMarkIdFetcherTest

Test the cursor-mark ID retrieval process.

CursorMarkIdFetcherTest::testWithFilters() — Method in class CursorMarkIdFetcherTest

Test passing filters.

TermsIdFetcherTestClass in namespace VuFindTest\Sitemap\Command

GetIdsWithTermsCommand Test Class

TermsIdFetcherTest::testFilters() — Method in class TermsIdFetcherTest

Test that filters are unsupported.

TermsIdFetcherTest::testFetching() — Method in class TermsIdFetcherTest

Test the terms retrieval process.

GeneratorTest::testEmptyWarnings() — Method in class GeneratorTest

Test that the warnings array is initialized correctly.

$ ContentPagesTest#themeInfoDataProperty in class ContentPagesTest

Theme data for testing

ContentPagesTest::testWithoutLanguages() — Method in class ContentPagesTest

Test URL generation without languages.

ContentPagesTest::testWithLanguages() — Method in class ContentPagesTest

Test URL generation with languages.

IndexTest::testEmptyConfigs() — Method in class IndexTest

Test that nothing happens if configuration is empty.

IndexTest::testRetrieval() — Method in class IndexTest

Test retrieving data from the index.

StartPageTest::testDefaults() — Method in class StartPageTest

Test defaults.

StartPageTest::testOptions() — Method in class StartPageTest

Test behavior with options configured.

SitemapIndexTest::testToString() — Method in class SitemapIndexTest

Test toString().

SitemapTest::testToString() — Method in class SitemapTest

Test toString().

SitemapTest::testToStringWithLanguagesAndFrequencies() — Method in class SitemapTest

Test toString() with multiple languages.

UtilsTest::testParseRange() — Method in class UtilsTest

Test parseRange functionality.

UtilsTest::testSanitizeDate() — Method in class UtilsTest

Test sanitizeDate functionality.

WriterTest::testCommit() — Method in class WriterTest

Test commit

WriterTest::testSave() — Method in class WriterTest

Test save

WriterTest::testSaveWithNonDefaults() — Method in class WriterTest

Test save with non-default parameters

WriterTest::testOptimize() — Method in class WriterTest

Test optimize

WriterTest::testDeleteAll() — Method in class WriterTest

Test delete all

WriterTest::testDeleteRecords() — Method in class WriterTest

Test delete records

TagsTestClass in namespace VuFindTest

Tags Test Class

TagsTest::testTagParsing() — Method in class TagsTest

Test tag parsing

TagsTest::testEmptyTagParsing() — Method in class TagsTest

Test empty tag parsing

TagsTest::testDeduplication() — Method in class TagsTest

Test deduplication

TagsTest::testTruncation() — Method in class TagsTest

Test truncation

ThemeCompilerTestClass in namespace VuFindTest

ThemeCompiler Test Class

$ ThemeCompilerTest#targetPathProperty in class ThemeCompilerTest

Path where new theme will be created

ThemeCompilerTest::testStandardCompilation() — Method in class ThemeCompilerTest

Test the compiler.

ThemeCompilerTest::testStandardCompilationWithMixin() — Method in class ThemeCompilerTest

Test the compiler with a mixin.

ThemeCompilerTest::testOverwriteProtection() — Method in class ThemeCompilerTest

Test overwrite protection.

ThemeCompilerTest::tearDown() — Method in class ThemeCompilerTest

Teardown method: clean up test directory.

ThemeInfoTestClass in namespace VuFindTest

ThemeInfo Test Class

ThemeInfoTest::testGetBaseDir() — Method in class ThemeInfoTest

Test getBaseDir

ThemeInfoTest::testThemeSetting() — Method in class ThemeInfoTest

Test get/setTheme

ThemeInfoTest::testInvalidTheme() — Method in class ThemeInfoTest

Test setting invalid theme

ThemeInfoTest::testGetThemeInfo() — Method in class ThemeInfoTest

Test theme info

ThemeInfoTest::testGetThemeInfoWithMixin() — Method in class ThemeInfoTest

Test theme info with a mixin

ThemeInfoTest::testUnfindableItem() — Method in class ThemeInfoTest

Test unfindable item.

ThemeInfoTest::testFindContainingTheme() — Method in class ThemeInfoTest

Test findContainingTheme()

ThemeInfoTest::testFindContainingThemeWithMixin() — Method in class ThemeInfoTest

Test findContainingTheme() with a mixin

ThemeInfoTest::testFindInThemes() — Method in class ThemeInfoTest

Test findInThemes()

ThemeInfoTest::testGetMergedConfigParentOnly() — Method in class ThemeInfoTest

Test getMergedConfig() with a basic theme

ThemeInfoTest::testGetMergedConfigChild() — Method in class ThemeInfoTest

Test getMergedConfig() using a child theme

ThemeInfoTest::testGetMergedConfigChildFlattened() — Method in class ThemeInfoTest

Test getMergedConfig() using a child theme and flattening

ThemeInfoTest::testGetMergedConfigMixin() — Method in class ThemeInfoTest

Test getMergedConfig() using a mixin

ThemeInfoTest::testGetMergedConfigMixinWithFlattening() — Method in class ThemeInfoTest

Test getMergedConfig() using a mixin and flattening

ThemeInfoTest::testGetMergedConfigReturnString() — Method in class ThemeInfoTest

Test getMergedConfig() on string value in config

ThemeInfoTest::testGetMergedConfigNoKey() — Method in class ThemeInfoTest

Test getMergedConfig() with no key (return all)

ThemeInfoTest::testCaching() — Method in class ThemeInfoTest

Test that caching works correctly.

ThemeInjectTemplateListenerFactoryTestClass in namespace VuFindTest

InjectTemplateListenerFactory Test Class

ThemeInjectTemplateListenerFactoryTest::testFactoryPrefixProcessing() — Method in class ThemeInjectTemplateListenerFactoryTest

Test that the factory correctly processes prefix configuration.

ThemeInjectTemplateListenerTestClass in namespace VuFindTest

InjectTemplateListener Test Class

ThemeInjectTemplateListenerTest::testPrefixStripping() — Method in class ThemeInjectTemplateListenerTest

Test prefix stripping.

ThemeInjectTemplateListenerTest::testCamelCaseToLowerCase() — Method in class ThemeInjectTemplateListenerTest

Test camelcase handling.

ThemeMobileTestClass in namespace VuFindTest

Mobile Test Class

ThemeMobileTest::testEnable() — Method in class ThemeMobileTest

Test namespace stripping.

ThemeMobileTest::testDetection() — Method in class ThemeMobileTest

Test detection wrapping.

ThemeResourceContainerTestClass in namespace VuFindTest

ResourceContainer Test Class

ThemeResourceContainerTest::testCss() — Method in class ThemeResourceContainerTest

Test CSS add/remove.

ThemeResourceContainerTest::testJs() — Method in class ThemeResourceContainerTest

Test Javascript add/remove.

ThemeResourceContainerTest::testJsDisabling() — Method in class ThemeResourceContainerTest

Test disabling JS.

ThemeResourceContainerTest::testJsException() — Method in class ThemeResourceContainerTest

Test Exception for priority + load_after in same js entry.

ThemeResourceContainerTest::testEncoding() — Method in class ThemeResourceContainerTest

Test Encoding set/get.

ThemeResourceContainerTest::testFavicon() — Method in class ThemeResourceContainerTest

Test Favicon set/get.

ThemeResourceContainerTest::testGenerator() — Method in class ThemeResourceContainerTest

Test Generator set/get.

ThemeResourceContainerTest::testConfigParsing() — Method in class ThemeResourceContainerTest

Test configuration parsing.

ILSDriverTestCase::testMissingConfiguration() — Method in class ILSDriverTestCase

Test that driver complains about missing configuration.

$ SessionHandlerTestCase#tablesProperty in class SessionHandlerTestCase

Mock database tables.

VuFindHighlighterTest::tearDown() — Method in class VuFindHighlighterTest
VuFindHighlighterTest::testGetHighlight() — Method in class VuFindHighlighterTest
DatabaseTest::testShortener() — Method in class DatabaseTest

Test that the shortener works correctly under "happy path."

DatabaseTest::testResolution() — Method in class DatabaseTest

Test that resolve is supported.

DatabaseTest::testResolutionOfBadInput() — Method in class DatabaseTest

Test that resolve errors correctly when given bad input

DatabaseTest::testResolutionOfOldIds() — Method in class DatabaseTest

Test that resolve errors correctly when given bad input

NoneTest::testShortener() — Method in class NoneTest

Test that the shortener does nothing.

NoneTest::testNoResolution() — Method in class NoneTest

Test that resolve is not supported.

SessionCsrfTest::testCounting() — Method in class SessionCsrfTest

Test counting behavior.

SessionCsrfTest::testTrimming() — Method in class SessionCsrfTest

Test trimming behavior.

ParentTemplateTest::testParent() — Method in class ParentTemplateTest

Test the basic parent function.

ParentTemplateTest::testSkip() — Method in class ParentTemplateTest

Test deeper parent return

ParentTemplateTest::testException() — Method in class ParentTemplateTest

Test thrown error

AlphaBrowseTest::testGetUrlWithMultipleRecordsAndDefaultSettings() — Method in class AlphaBrowseTest

Test that get URL displays an appropriate link for multiple results with default settings.

AlphaBrowseTest::testGetUrlWithSingleRecordAndDefaultSettings() — Method in class AlphaBrowseTest

Test that get URL displays an appropriate link for a single result with default settings.

AlphaBrowseTest::testGetUrlEscapesQuotes() — Method in class AlphaBrowseTest

Test that get URL properly escapes quotes in headings.

AlphaBrowseTest::testGetUrlAppliesFilterBypassSetting() — Method in class AlphaBrowseTest

Test that get URL omits dfApplied when the bypass_default_filters option is false.

CartTest::testCart() — Method in class CartTest

Test the helper

CitationTest::testCitations() — Method in class CitationTest

Test citation generation

ComponentTest::testComponent() — Method in class ComponentTest

Test basic Component conversion

ContentTest::testBehaviorWithTrailingSlash() — Method in class ContentTest

Test that the helper works when the $pathPrefix parameter has a trailing slash.

ContentTest::testBehaviorWithoutTrailingSlash() — Method in class ContentTest

Test that the helper works when the $pathPrefix parameter has no trailing slash.

CookieConsentTest::testHelperInactive() — Method in class CookieConsentTest

Test inactive helper

CookieConsentTest::testHelperWithoutConsent() — Method in class CookieConsentTest

Test helper without consent

CookieConsentTest::testHelperWithConsent() — Method in class CookieConsentTest

Test helper with consent

CookieConsentTest::testHelperWithBadConsentRevision() — Method in class CookieConsentTest

Test helper with non-matching consent revision

CspTest::testDisablePolicyWithCspEnabled() — Method in class CspTest

Test disablePolicy when the CSP is enabled

CspTest::testDisablePolicyWithCspReportOnly() — Method in class CspTest

Test disablePolicy when the CSP is in "report only" mode

CspTest::testDisablePolicyWithCspDisabled() — Method in class CspTest

Test disablePolicy when the CSP is disabled

CurrencyFormatterTest::tearDown() — Method in class CurrencyFormatterTest

Standard teardown method

CurrencyFormatterTest::testFormatting() — Method in class CurrencyFormatterTest

Test the class

FlashmessagesTest::testFlashmessages() — Method in class FlashmessagesTest

Test Flashmessages.

GoogleAnalyticsTest::testOldSetup() — Method in class GoogleAnalyticsTest

Test the helper (old mode)

GoogleAnalyticsTest::testNewSetup() — Method in class GoogleAnalyticsTest

Test the helper (Universal Analytics mode)

GoogleAnalyticsTest::testCustomCreateOptions() — Method in class GoogleAnalyticsTest

Test custom create options.

GoogleAnalyticsTest::testDefaultCreateOptions() — Method in class GoogleAnalyticsTest

Test default create options.

GoogleAnalyticsTest::testDisabled() — Method in class GoogleAnalyticsTest

Test the helper (disabled mode)

GoogleTagManagerTest::testHeadCode() — Method in class GoogleTagManagerTest

Test getHeadCode()

GoogleTagManagerTest::testBodyCode() — Method in class GoogleTagManagerTest

Test getBodyCode()

GoogleTagManagerTest::testDisabled() — Method in class GoogleTagManagerTest

Test the helper (disabled mode)

HelpTextTest::testMissingHelp() — Method in class HelpTextTest

Test that an appropriate warning is set when help is missing.

HelpTextTest::testMissingLanguageHelp() — Method in class HelpTextTest

Test that an appropriate warning is set when help is not found in the requested language.

HelpTextTest::testSuccess() — Method in class HelpTextTest

Test an entirely successful render operation.

HoldingsTest::testBarcodeVisibilityBehavior() — Method in class HoldingsTest

Test appropriate barcode display behavior for various configurations.

IconTest::testFontIcon() — Method in class IconTest

Test that we can generate a font-based icon.

IconTest::testFontIconWithExtraClass() — Method in class IconTest

Test that we can generate a font-based icon with an extra class.

IconTest::testFontIconWithExtras() — Method in class IconTest

Test that we can generate a font-based icon with extra attributes.

IconTest::testCaching() — Method in class IconTest

Test that caching works correctly.

IconTest::testImageIcon() — Method in class IconTest

Test that we can generate an image-based icon.

IconTest::testImageIconWithExtraClasses() — Method in class IconTest

Test that we can generate an image-based icon with extra classes in the configuration (including a class name with a colon in it).

IconTest::testImageIconWithExtras() — Method in class IconTest

Test that we can generate an image-based icon with extras.

IconTest::testRTL() — Method in class IconTest

Test RTL

IconTest::testAlias() — Method in class IconTest

Test that we can use an alias

IconTest::testDirectCircularAlias() — Method in class IconTest

Test that we can detect a direct circular alias

IconTest::testIndirectCircularAlias() — Method in class IconTest

Test that we can detect an indirect circular alias

IconTest::testSvgIcon() — Method in class IconTest

Test that we can generate an SVG icon.

IconTest::testSvgIconWithExtras() — Method in class IconTest

Test that we can generate an SVG icon with extras.

JsTranslationsTest::testHelper() — Method in class JsTranslationsTest

Test JS translations.

LinkifyTest::testLinkify() — Method in class LinkifyTest

Test that Linkify proxies the UrlHighlight object as expected.

MakeLinkTest::testLink() — Method in class MakeLinkTest

Test that responds to common inputs

MakeLinkTest::testSpan() — Method in class MakeLinkTest

Test that helper returns unescaped text when href is falsey

MakeLinkTest::testAttributes() — Method in class MakeLinkTest

Test that responds to common inputs

MakeLinkTest::testOptionEscaping() — Method in class MakeLinkTest

Test escaping with other plugins

MakeLinkTest::testOptionProxy() — Method in class MakeLinkTest

Test that helper obeys options

MakeTagTest::testElements() — Method in class MakeTagTest

Test all data providers above

MakeTagTest::testValidTagNames() — Method in class MakeTagTest

Test tag name edge cases

MakeTagTest::testInvalidTagNames() — Method in class MakeTagTest

Test exception on bad tag names

MakeTagTest::testDeprecatedElementTriggersWarning() — Method in class MakeTagTest

Test deprecated elements

MarkdownTest::testMarkdown() — Method in class MarkdownTest

Test basic markdown conversion

MetadataTest::testMetadata() — Method in class MetadataTest

Test basic functionality of the helper.

OpenUrlTest::testCheckContextDefaults() — Method in class OpenUrlTest

Test checkContext() default behavior.

OpenUrlTest::testCheckContextWithOverrides() — Method in class OpenUrlTest

Test checkContext() behavior with configuration overrides.

OpenUrlTest::testCheckContextNoUrl() — Method in class OpenUrlTest

Test checkContext() with no URL set (everything should be false!)

OpenUrlTest::testCheckExcludedRecordsRulesFalse() — Method in class OpenUrlTest

Test checkExcludedRecordRules() with rule not applying (isActive() will return TRUE!!)

OpenUrlTest::testCheckExcludedRecordsRulesTrue() — Method in class OpenUrlTest

Test checkExcludedRecordRules() with matching rule (isActive() will return FALSE!!)

OpenUrlTest::testCheckExcludedRecordsRulesFalseDueToWildcardFailure() — Method in class OpenUrlTest

Test checkExcludedRecordRules() with no matching rule (isActive() will return FALSE!!). Specifically we're testing the case where a method has a generic wildcard match in the rules but returns an empty value.

OpenUrlTest::testCheckSupportedRecordsRulesFalse() — Method in class OpenUrlTest

Test checkSupportedRecordRules() with no matching rule (isActive() will return FALSE!!)

OpenUrlTest::testCheckSupportedRecordsRulesWithWildcardStillFalse() — Method in class OpenUrlTest

Test checkSupportedRecordRules() with no matching rule (isActive() will return FALSE!!) This test is specifically designed to test wildcards -- we want to be sure that ['CrazyFormat'] will NOT match ['Article', '*'].

OpenUrlTest::testCheckSupportedRecordsRulesTrue() — Method in class OpenUrlTest

Test checkSupportedRecordRules() with matching rule (isActive() will return TRUE!!)

OpenUrlTest::testRecordDriverClassInRules() — Method in class OpenUrlTest

Test checkSupportedRecordRules() to see if it accounts for record driver class.

PermissionTest::testMessageDisplay() — Method in class PermissionTest

Test the message display

PermissionTest::testTemplateDisplay() — Method in class PermissionTest

Test the template display

PermissionTest::testExistingTemplateDisplay() — Method in class PermissionTest

Test the template display with an existing template

RecordDataFormatterTest::testFormatting() — Method in class RecordDataFormatterTest

Test formatting.

SpecBuilderTest::testBuilder() — Method in class SpecBuilderTest

Test the spec builder

RecordLinkerTest::testRecordUrl() — Method in class RecordLinkerTest

Test record URL creation.

RecordLinkerTest::testPercentEscaping() — Method in class RecordLinkerTest

Make sure any percent signs in record ID are properly URL-encoded

RecordLinkerTest::testMultiQueryParams() — Method in class RecordLinkerTest

Test behavior when there are multiple GET parameters

$ RecordTest#testThemeProperty in class RecordTest

Theme to use for testing purposes.

RecordTest::testMissingTemplate() — Method in class RecordTest

Test attempting to display a template that does not exist.

RecordTest::testMissingTemplateWithoutException() — Method in class RecordTest

Test attempting to display a template that does not exist without throwing an exception.

RecordTest::testTemplateInheritance() — Method in class RecordTest

Test template inheritance.

RecordTest::testGetExport() — Method in class RecordTest

Test getExport.

RecordTest::testGetFormatClass() — Method in class RecordTest

Test getFormatClass.

RecordTest::testGetFormatList() — Method in class RecordTest

Test getFormatList.

RecordTest::testGetToolbar() — Method in class RecordTest

Test getToolbar.

RecordTest::testGetCollectionMetadata() — Method in class RecordTest

Test getCollectionMetadata.

RecordTest::testGetSearchResult() — Method in class RecordTest

Test getSearchResult.

RecordTest::testGetListEntry() — Method in class RecordTest

Test getListEntry.

RecordTest::testGetPreviewIds() — Method in class RecordTest

Test getPreviewIds.

RecordTest::testGetPreviews() — Method in class RecordTest

Test getPreviews.

RecordTest::testGetLink() — Method in class RecordTest

Test getLink.

RecordTest::testGetCheckbox() — Method in class RecordTest

Test getCheckbox.

RecordTest::testGetTab() — Method in class RecordTest

Test getTab.

RecordTest::testGetQrCodeFailures() — Method in class RecordTest

Test various ways of making getQrCode() fail.

RecordTest::testGetQrCodeSuccess() — Method in class RecordTest

Test successful getQrCode() call.

RecordTest::testGetThumbnailNone() — Method in class RecordTest

Test getThumbnail() - no thumbnail case

RecordTest::testGetThumbnailHardCoded() — Method in class RecordTest

Test getThumbnail() - hardcoded thumbnail case

RecordTest::testGetThumbnailDynamic() — Method in class RecordTest

Test getThumbnail() - dynamic thumbnail case

RecordTest::testGetLinkDetailsEmpty() — Method in class RecordTest

Test getLinkDetails with an empty list

RecordTest::testGetLinkDetailsSuccess() — Method in class RecordTest

Test getLinkDetails with valid details

RecordTest::testGetLinkDetailsFailure() — Method in class RecordTest

Test getLinkDetails with invalid details

RecordTest::testGetLinkDetailsWithDuplicateURLs() — Method in class RecordTest

Test getLinkDetails with duplicate URLs

RecordTest::testGetUrlList() — Method in class RecordTest

Test getUrlList

SafeMoneyFormatTest::tearDown() — Method in class SafeMoneyFormatTest

Standard teardown method

SafeMoneyFormatTest::testFormatting() — Method in class SafeMoneyFormatTest

Test the helper

SearchMemoryTest::testGetLastSearchParams() — Method in class SearchMemoryTest

Test search memory helper

SearchTabsTest::testGetCurrentHiddenFilterParams() — Method in class SearchTabsTest

Test search memory helper

ShortenUrlTest::testHelper() — Method in class ShortenUrlTest

Test that helper proxies to appropriate service.

TranslateTestClass in namespace VuFindTest\View\Helper\Root

Translate view helper Test Class (and by extension, the TranslatorAwareTrait)

TranslateTest::testTranslateWithoutTranslator() — Method in class TranslateTest

Test translation without a loaded translator

TranslateTest::testTranslateWithEmptyArray() — Method in class TranslateTest

Test invalid translation array

TranslateTest::testTranslateWithOverfilledArray() — Method in class TranslateTest

Test invalid translation array

TranslateTest::testTranslateWithTranslator() — Method in class TranslateTest

Test translation with a loaded translator

TranslateTest::testTranslateTranslatableStringDefaultValues() — Method in class TranslateTest

Test TranslatableString default values.

TranslateTest::testTranslateTranslatableStringWithTranslator() — Method in class TranslateTest

Test translation of a TranslatableString object with a loaded translator

TranslateTest::testTranslateTranslatableStringAndTextDomainsWithTranslator() — Method in class TranslateTest

Test translation of a TranslatableString object using text domains with a loaded translator

TranslateTest::testTranslateTextDomainWithTranslator() — Method in class TranslateTest

Test translation with a loaded translator and a text domain

TranslateTest::testTranslateNestedTextDomainWithConflict() — Method in class TranslateTest

Test nested translation with potential text domain conflict

TranslateTest::testLocaleWithoutTranslator() — Method in class TranslateTest

Test locale retrieval without a loaded translator

TranslateTest::testLocaleWithTranslator() — Method in class TranslateTest

Test locale retrieval without a loaded translator

TranslateTest::testGetTranslator() — Method in class TranslateTest

Test translator retrieval.

TranslationEmptyTestClass in namespace VuFindTest\View\Helper\Root

TranslationEmpty view helper Test Class

TranslationEmptyTest::testTranslationEmpty() — Method in class TranslationEmptyTest

Test TranslationEmpty

SetupThemeResourcesTest::testHelper() — Method in class SetupThemeResourcesTest

Test the helper.

SetupThemeResourcesTest::testConfigParsing() — Method in class SetupThemeResourcesTest

Test configuration parsing.

SlotTest::testInstance() — Method in class SlotTest

Test the helper.

SlotTest::testGet() — Method in class SlotTest

Test get value of slot.

SlotTest::testSet() — Method in class SlotTest

Test setting value of slot blocking later sets.

SlotTest::testCapture() — Method in class SlotTest

Test capturing echo with start and end.

SlotTest::testClear() — Method in class SlotTest

Test clearing blocks and allowing for override.

SlotTest::testPrepend() — Method in class SlotTest

Test prepending more to blocks.

SlotTest::testAppend() — Method in class SlotTest

Test appending more to blocks.

SlotTest::testNesting() — Method in class SlotTest

Test nested slots.

SlotTest::testNestingWithoutEcho() — Method in class SlotTest

Test nested slots showing that children don't appear in parent without echo.

TemplatePathTestClass in namespace VuFindTest\View\Helper

TemplatePath view helper Test Class

TemplatePathTest::testExists() — Method in class TemplatePathTest

Test the basic parent function.

TemplatePathTest::testThemeDoesntExist() — Method in class TemplatePathTest

Test thrown error

TemplatePathTest::testFileDoesntExist() — Method in class TemplatePathTest

Test thrown error

VuFindGeoTest::testDataExtraction() — Method in class VuFindGeoTest

Test basic data extraction using valid values.

VuFindTest::testGetChangeTracker() — Method in class VuFindTest

Test the getChangeTracker helper.

VuFindTest::testGetConfig() — Method in class VuFindTest

Test the getConfig helper.

VuFindTest::testHarvestTextFile() — Method in class VuFindTest

Test the harvestTextFile helper.

VuFindTest::testStripBadChars() — Method in class VuFindTest

Test the stripBadChars helper.

VuFindTest::testMapString() — Method in class VuFindTest

Test the mapString helper.

VuFindTest::testStripArticles() — Method in class VuFindTest

Test the stripArticles helper.

VuFindTest::testXmlAsText() — Method in class VuFindTest

Test the xmlAsText helper.

VuFindTest::testRemoveTagAndReturnXMLasText() — Method in class VuFindTest

Test the removeTagAndReturnXMLasText helper.

VuFindTest::testExplode() — Method in class VuFindTest

Test the explode helper.

VuFindTest::testImplode() — Method in class VuFindTest

Test the implode helper.

VuFindTest::testExtractBestDateOrRange() — Method in class VuFindTest

Test the extractBestDateOrRange helper.

VuFindTest::testExtractEarliestYear() — Method in class VuFindTest

Test the extractEarliestYear helper.

VuFindTest::testIsInvertedName() — Method in class VuFindTest

Test the isInvertedName helper.

VuFindTest::testInvertName() — Method in class VuFindTest

Test the invertName helper.

VuFindTest::testInvertNames() — Method in class VuFindTest

Test the invertNames helper.

VuFindWorkKeysTest::testGetWorkKeysWithIncludeRegEx() — Method in class VuFindWorkKeysTest

Test the work keys helper with an include regex.

VuFindWorkKeysTest::testGetWorkKeysWithIncludeRegExAndDuplicateTitles() — Method in class VuFindWorkKeysTest

Test the work keys helper with an include regex and trimmed titles === titles.

VuFindWorkKeysTest::testGetWorkKeysWithExcludeRegEx() — Method in class VuFindWorkKeysTest

Test the work keys helper with an exclude regex.

VuFindWorkKeysTest::testGetWorkKeysWithTransliteration() — Method in class VuFindWorkKeysTest

Test the work keys helper with an ICU tranliteration.

VuFindWorkKeysTest::testGetWorkKeysWithoutAuthors() — Method in class VuFindWorkKeysTest

Test the work keys helper with an ICU tranliteration.

$ AbstractCssPreCompiler#themeConfigKeyProperty in class AbstractCssPreCompiler

Key in theme.config.php that lists all files

$ AbstractCssPreCompiler#tempPathProperty in class AbstractCssPreCompiler

Temporary directory for cached files.

$ Initializer#toolsProperty in class Initializer

Theme tools object

$ Initializer#themeInitializedProperty in class Initializer

A static flag used to determine if the theme has been initialized

$ ScssCompiler#themeConfigKeyProperty in class ScssCompiler

Key in theme.config.php that lists all files

ThemeCompilerClass in namespace VuFindTheme

Class to compile a theme hierarchy into a single flat theme.

ThemeGeneratorClass in namespace VuFindTheme

Class to generate a new theme from a template and reconfigure VuFind to use it.

ThemeGeneratorFactoryClass in namespace VuFindTheme

Factory for ThemeGenerator.

ThemeInfoClass in namespace VuFindTheme

Class to represent currently-selected theme and related information.

ThemeInfoFactoryClass in namespace VuFindTheme

ThemeInfo factory.

ThemeInfoInjectorFactoryClass in namespace VuFindTheme

Factory for objects that depend on the ThemeInfo object.

ConcatTrait::toString() — Method in class ConcatTrait

Render link elements as string Customized to minify and concatenate

$ HeadLink#themeInfoProperty in class HeadLink

Theme information service

$ HeadScript#themeInfoProperty in class HeadScript

Theme information service

$ ImageLink#themeInfoProperty in class ImageLink

Theme information service

$ ParentTemplate#templatePathStackProperty in class ParentTemplate

Inheritance stack of template folder paths

TemplatePathClass in namespace VuFindTheme\View\Helper

Helper to get path to a template from another theme (for including)

$ TemplatePath#templatePathStackProperty in class TemplatePath

Template path stack

TemplatePathFactoryClass in namespace VuFindTheme\View\Helper

TemplatePath helper factory.

$ CommentRecord#tableProperty in class CommentRecord

Resource database table

$ DeleteRecordComment#tableProperty in class DeleteRecordComment

Comments database table

GetItemStatuses::translateList() — Method in class GetItemStatuses

Translate an array of strings using a prefix.

$ GetRecordDetails#tabManagerProperty in class GetRecordDetails

Record tab plugin manager

$ GetRecordTags#tableProperty in class GetRecordTags

Tags database table

$ GetRecordVersions#tabManagerProperty in class GetRecordVersions

Tab manager

TagRecordClass in namespace VuFind\AjaxHandler

AJAX handler to tag/untag a record.

$ TagRecord#tagParserProperty in class TagRecord

Tag parser

TagRecordFactoryClass in namespace VuFind\AjaxHandler

Factory for TagRecord AJAX handler.

$ AuthToken#tokenProperty in class AuthToken

Access token

$ AuthToken#tokenTypeProperty in class AuthToken

Token type (usually 'Bearer')

$ AuthToken#timeCreatedProperty in class AuthToken

Timestamp of token creation

TagClass in namespace VuFind\Autocomplete

Tag Autocomplete Module

$ Interval#timeFromSessionStartProperty in class Interval

Minimum time from session start to first action

$ ListItems#tagsProperty in class ListItems

Tags of lists to display

TrendingILSItemsClass in namespace VuFind\ChannelProvider

"Trending ILS items" channel provider.

$ Upgrade#toProperty in class Upgrade

Version we're upgrading to

$ IlsStatusMonitor#targetProperty in class IlsStatusMonitor

Target selector for status message.

TemplateBasedClass in namespace VuFind\ContentBlock

Class TemplateBased

$ TemplateBased#templateNameProperty in class TemplateBased

Name of template for rendering

TemplateBasedFactoryClass in namespace VuFind\ContentBlock

TemplateBased factory

$ AbstractSyndetics#timeoutProperty in class AbstractSyndetics

HTTP timeout for API calls (in seconds)

Bokinfo::testUrlFunction() — Method in class Bokinfo

Test that the url is really working

$ PageLocator#typesProperty in class PageLocator

Types/formats of content

$ PageLocator#themeInfoProperty in class PageLocator

Theme info service

AbstractBase::tagsEnabled() — Method in class AbstractBase

Are tags enabled?

$ AbstractRecord#tabsExtraScriptsProperty in class AbstractRecord

Array of extra scripts for tabs

BrowseController::tagAction() — Method in class BrowseController

Browse tags

BrowseController::topicAction() — Method in class BrowseController

Browse Topic

$ ContentController#typesProperty in class ContentController

Types/formats of content

InstallController::testSearchService() — Method in class InstallController

Support method to test the search service

InstallController::testSslCertConfig() — Method in class InstallController

Try switching to a specific SSL configuration.

OAuth2Controller::tokenAction() — Method in class OAuth2Controller

OAuth2 token request action

$ DbUpgrade#tableInfoProperty in class DbUpgrade

Table metadata

DbUpgrade::typeMatches() — Method in class DbUpgrade

Given a table column object, return true if the object's type matches the specified $type parameter. Return false if there is a mismatch that will require table structure updates.

$ Favorites#tagsProperty in class Favorites

Tag parser

TagControllerClass in namespace VuFind\Controller

Tag Controller

$ Generator#themeToolsProperty in class Generator

ThemeInfo object

AbstractTextLayer::textWidth() — Method in class AbstractTextLayer

Returns the width a string would render to

AbstractTextLayer::textHeight() — Method in class AbstractTextLayer

Returns the height a string would render to

$ Loader#typeProperty in class Loader

User type parameter

$ Resource#titleProperty in class Resource
$ Search#titleProperty in class Search
TagsClass in namespace VuFind\Db\Row

Row Definition for tags

$ UserList#tagParserProperty in class UserList

Tag parser.

$ UserList#titleProperty in class UserList
$ DbTableAwareTrait#tableManagerProperty in class DbTableAwareTrait

Database table plugin manager

$ Gateway#tableManagerProperty in class Gateway

Table manager

TagsClass in namespace VuFind\Db\Table

Table Definition for tags

$ Feed#totalResultsProperty in class Feed

Total results

$ Database#tableProperty in class Database

Feedback table

ConfigurationBased::treeSorting() — Method in class ConfigurationBased

Check if sorting is enabled in the hierarchy Options

$ AbstractBase#topNodeProperty in class AbstractBase

Top-level record from index

JSTree::transformCollectionXML() — Method in class JSTree

Transforms Collection XML to Desired Format

TranslatableStringClass in namespace VuFind\I18n

Class for translatable string with a special default translation.

$ TranslatableString#translatableProperty in class TranslatableString

Whether translation is allowed

TranslatableStringInterfaceClass in namespace VuFind\I18n

Interface for translatable strings.

TranslatorAwareInterfaceClass in namespace VuFind\I18n\Translator

Lightweight translator aware marker interface (used as an alternative to \Laminas\I18n\Translator\TranslatorAwareInterface, which requires an excessive number of methods to be implemented).

TranslatorAwareTraitClass in namespace VuFind\I18n\Translator

Lightweight translator aware marker interface (used as an alternative to \Laminas\I18n\Translator\TranslatorAwareInterface, which requires an excessive number of methods to be implemented). If we switch to PHP 5.4 traits in the future, we can eliminate this interface in favor of the default Laminas version.

$ TranslatorAwareTrait#translatorProperty in class TranslatorAwareTrait
Translator
TranslatorAwareTrait::translate() — Method in class TranslatorAwareTrait

Translate a string (or string-castable object)

TranslatorAwareTrait::translateWithPrefix() — Method in class TranslatorAwareTrait

Translate a string (or string-castable object) using a prefix, or without the prefix if a prefixed translation is not found.

TranslatorAwareTrait::translateString() — Method in class TranslatorAwareTrait

Get translation for a string

TranslatorFactoryClass in namespace VuFind\I18n\Translator

Translator factory.

$ Connection#titleHoldsModeProperty in class Connection

Title-level holds mode

AbstractBase::throwAsIlsException() — Method in class AbstractBase

Rethrow the provided exception as an ILS exception.

$ Aleph#translatorProperty in class Aleph
Translator
$ AlephTranslator#table15Property in class AlephTranslator

Table 15 configuration

$ AlephTranslator#table40Property in class AlephTranslator

Table 40 configuration

$ AlephTranslator#table_sub_libraryProperty in class AlephTranslator

Sub library configuration table

AlephTranslator::tab40Translate() — Method in class AlephTranslator

Get a tab40 collection description

AlephTranslator::tabSubLibraryTranslate() — Method in class AlephTranslator

Support method for tab15Translate -- translate a sub-library name

AlephTranslator::tab15Translate() — Method in class AlephTranslator

Get a tab15 item status

AlephTranslator::tab15Callback() — Method in class AlephTranslator

Callback for tab15 (modify $tab15 by reference)

AlephTranslator::tab40Callback() — Method in class AlephTranslator

Callback for tab40 (modify $tab40 by reference)

AlephTranslator::tabSubLibraryCallback() — Method in class AlephTranslator

Sub-library callback (modify $tab_sub_library by reference)

$ Demo#totalRecordsProperty in class Demo

Total count of records in the Solr index (used for random bib lookup)

$ Folio#tenantProperty in class Folio

Authentication tenant (X-Okapi-Tenant)

$ Folio#tokenProperty in class Folio

Authentication token (X-Okapi-Token)

$ GeniePlus#tokenProperty in class GeniePlus

Access token

KohaILSDI::tableExists() — Method in class KohaILSDI

Check if a table exists in the current database.

KohaILSDI::toKohaDate() — Method in class KohaILSDI

To Koha Date

KohaRest::translateLocation() — Method in class KohaRest

Translate location name

$ SierraRest#titleHoldBibLevelsProperty in class SierraRest

Bib levels for which title level hold is allowed

SierraRest::translateLocation() — Method in class SierraRest

Translate location name

SierraRest::translateOpacMessage() — Method in class SierraRest

Translate OPAC message

Symphony::translatePolicyID() — Method in class Symphony

Translate a Symphony policy ID into a policy description (e.g. VIDEO-COLL => Videorecording Collection).

Unicorn::toUTF8() — Method in class Unicorn

Convert the given ISO-8859-1 string to UTF-8 if it is not already UTF-8.

$ VoyagerRestful#titleHoldsModeProperty in class VoyagerRestful

Title-level holds mode

$ XCNCIP2#tokenBasicAuthProperty in class XCNCIP2

Use HTTP basic authorization when getting OAuth2 token

$ XCNCIP2#translationDomainProperty in class XCNCIP2

Domain used to translate messages from ILS

XCNCIP2::translateMessage() — Method in class XCNCIP2

Translate a message from ILS

TitleHoldsClass in namespace VuFind\ILS\Logic

Title Hold Logic Class

$ ImageLoader#themeToolsProperty in class ImageLoader

Theme tools

$ Office365#titleProperty in class Office365

The title for generated cards.

$ Mailer#transportProperty in class Mailer

Mail transport

$ Server#tableManagerProperty in class Server

Table manager

$ AbstractTokenRepository#tokenTypeProperty in class AbstractTokenRepository

Token type.

$ AbstractTokenRepository#tableProperty in class AbstractTokenRepository

Token table

$ EuropeanaResults#targetUrlProperty in class EuropeanaResults

Fully constructed API URL

$ ExternalSearch#templateProperty in class ExternalSearch

URL template string

$ FavoriteFacets#tagSettingProperty in class FavoriteFacets

Tag capability setting

$ SummonResultsDeferred#typeLabelProperty in class SummonResultsDeferred

Label for current search type

$ SwitchTab#tabSelectionsProperty in class SwitchTab

Current tab settings

TopFacetsClass in namespace VuFind\Recommend

SideFacets Recommendations Module

AbstractBase::tryMethod() — Method in class AbstractBase

Try to call the requested method and return null if it is unavailable; this is useful for checking for the existence of get methods for particular types of data without causing fatal errors.

EDS::toHTML() — Method in class EDS

Parse a SimpleXml element and return it's inner XML as an HTML string

$ IlsAwareTrait#titleHoldLogicProperty in class IlsAwareTrait

Title hold logic

$ AbstractContentFactory#tabNameProperty in class AbstractContentFactory

The name of the tab being constructed.

$ ExcerptFactory#tabNameProperty in class ExcerptFactory

The name of the tab being constructed.

$ HierarchyTree#treeListProperty in class HierarchyTree

Tree data

$ HoldingsILS#templateProperty in class HoldingsILS

Name of template to use for rendering holdings.

$ ReviewsFactory#tabNameProperty in class ReviewsFactory

The name of the tab being constructed.

TOCClass in namespace VuFind\RecordTab

Table of Contents tab

TOCFactoryClass in namespace VuFind\RecordTab

Factory for building TOC tab.

$ TOCFactory#tabNameProperty in class TOCFactory

The name of the tab being constructed.

TabInterfaceClass in namespace VuFind\RecordTab

Record tab interface

TabManagerClass in namespace VuFind\RecordTab

Record tab manager

TabManagerFactoryClass in namespace VuFind\RecordTab

Factory for building the TabManager.

$ AbstractFallbackLoader#tableProperty in class AbstractFallbackLoader

Resource table

$ Bookplate#thumbUrlTemplateProperty in class Bookplate

URL temlate for thumbnail

$ CsvReader#templateProperty in class CsvReader

Field template (value => index)

ThreesixtylinkClass in namespace VuFind\Resolver\Driver

360Link Link Resolver Driver

Clickatell::text() — Method in class Clickatell

Send a text message to the specified provider.

Mailer::text() — Method in class Mailer

Send a text message to the specified provider.

SMSInterface::text() — Method in class SMSInterface

Send a text message to the specified provider.

$ Options#translatedFacetsProperty in class Options

Facet settings

$ Options#translatedFacetsTextDomainsProperty in class Options

Text domains for translated facets

$ Options#translatedFacetsFormatsProperty in class Options

Formats for translated facets

Params::translateFacetValue() — Method in class Params

Translate a facet value.

Params::translate() — Method in class Params

Translate a string (or string-castable object)

Results::translate() — Method in class Results

Translate a string if a translator is available (proxies method in Options).

Params::translateFacetName() — Method in class Params

Translate a facet field name

Params::translateFilter() — Method in class Params

Translate a filter

Params::translateSearchType() — Method in class Params

Translate a search type

Params::translateSort() — Method in class Params

Translate a sort option

$ Minified#tProperty in class Minified

Search terms

$ Minified#tyProperty in class Minified

Search type

$ SearchTabsHelper#tabConfigProperty in class SearchTabsHelper

Tab configuration

$ HierarchicalFacetListener#translatedFacetsProperty in class HierarchicalFacetListener

Facet settings

$ HierarchicalFacetListener#translatedFacetsTextDomainsProperty in class HierarchicalFacetListener

Text domains for translated facets

SpellingProcessor::tokenize() — Method in class SpellingProcessor

Input Tokenizer - Specifically for spelling purposes

$ Results#topicRecommendationsProperty in class Results

Topic recommendations

$ Results#tagsTableProperty in class Results

Tags table

$ AbstractFile#topTagProperty in class AbstractFile

Top-level tag.

AbstractFile::toString() — Method in class AbstractFile

Get the map as a string.

$ ContentPages#themeInfoProperty in class ContentPages

Theme informations

TermsIdFetcherClass in namespace VuFind\Sitemap\Plugin\Index

Plugin to get IDs for a sitemap from a backend using terms (if supported).

TagsClass in namespace VuFind

VuFind tag processing logic

TagsFactoryClass in namespace VuFind

Tags factory.

$ Database#tableProperty in class Database

Table containing shortlinks

CsrfInterface::trimTokenList() — Method in class CsrfInterface

Keep only the most recent N tokens.

SessionCsrf::trimTokenList() — Method in class SessionCsrf

Keep only the most recent N tokens.

$ ClassBasedTemplateRendererTrait#templateCacheProperty in class ClassBasedTemplateRendererTrait

Cache for found templates

$ Content#templateBasedBlockProperty in class Content

TemplateBased instance to resolve translated pages.

$ DisplayLanguageOption#translatorProperty in class DisplayLanguageOption

Translator (or null if unavailable)

$ Feedback#tabProperty in class Feedback

Is the tab enabled?

Feedback::tabEnabled() — Method in class Feedback

This will retrieve the config for whether or not the tab is enabled.

$ HistoryLabel#translatorProperty in class HistoryLabel

Translation helper

$ JsTranslations#translateProperty in class JsTranslations

Translate helper

$ JsTranslations#transEscProperty in class JsTranslations

Translate + escape helper

$ Matomo#timestampProperty in class Matomo

A timestamp used to identify the init function to avoid name clashes when opening lightboxes.

Matomo::trackSearch() — Method in class Matomo

Track a Search

Matomo::trackCombinedSearch() — Method in class Matomo

Track a Combined Search

Matomo::trackRecordPage() — Method in class Matomo

Track a Record View

Matomo::trackPageView() — Method in class Matomo

Track a Generic Page View

$ Piwik#timestampProperty in class Piwik

A timestamp used to identify the init function to avoid name clashes when opening lightboxes.

Piwik::trackSearch() — Method in class Piwik

Track a Search

Piwik::trackCombinedSearch() — Method in class Piwik

Track a Combined Search

Piwik::trackRecordPage() — Method in class Piwik

Track a Record View

Piwik::trackPageView() — Method in class Piwik

Track a Generic Page View

ThemeConfigClass in namespace VuFind\View\Helper\Root

Theme config view helper

$ ThemeConfig#themeInfoProperty in class ThemeConfig

ThemeInfo object to access themeConfig

ThemeConfigFactoryClass in namespace VuFind\View\Helper\Root

Icon helper factory.

TransEscClass in namespace VuFind\View\Helper\Root

Translate + escape view helper

TransEscAttrClass in namespace VuFind\View\Helper\Root

Translate + escape view helper for HTML attributes

TransEscWithPrefixClass in namespace VuFind\View\Helper\Root

Translate with prefix + escape view helper

TranslateClass in namespace VuFind\View\Helper\Root

Translate view helper

TranslationEmptyClass in namespace VuFind\View\Helper\Root

Helper to check if a translation is empty

TruncateClass in namespace VuFind\View\Helper\Root

Truncate view helper

U

UpdateResourcesFromSolrCommandClass in namespace KnihovnyCzConsole\Command\Util

Class UpdateResourcesFromSolrCommand

UpdateResourcesFromSolrCommandFactoryClass in namespace KnihovnyCzConsole\Command\Util

Class UpdateResourcesFromSolrCommandFactory

$ GetObalkyKnihCoverWithoutSolr#useCoverFallbacksOnFailProperty in class GetObalkyKnihCoverWithoutSolr

If true we will render a fallback html template in case no image could be loaded

$ HarvestWidgetsContents#userListProperty in class HarvestWidgetsContents

User list table

Manager::updateSession() — Method in class Manager

Updates the user information in the session.

UserListClass in namespace KnihovnyCz\ContentBlock

Class UserList

MyResearchController::userSettingsAction() — Method in class MyResearchController

User settings action

UserClass in namespace KnihovnyCz\Db\Row

Class User

$ User#usernameProperty in class User
$ User#user_provided_emailProperty in class User
User::updateLibraryCardEntry() — Method in class User

Verify that the current card information exists in user's library cards (if enabled) and is up to date.

UserCardClass in namespace KnihovnyCz\Db\Row

Class UserCard

$ UserCard#user_idProperty in class UserCard
UserListClass in namespace KnihovnyCz\Db\Row

Class UserList

$ UserList#usedListsProperty in class UserList

List ids used in configuration

UserListCategoriesClass in namespace KnihovnyCz\Db\Row

Class UserListCategories

UserListFactoryClass in namespace KnihovnyCz\Db\Row

Class UserListFactory

UserSettingsClass in namespace KnihovnyCz\Db\Row

Class UserSettings

$ UserSettings#user_idProperty in class UserSettings
UserClass in namespace KnihovnyCz\Db\Table

Class User

UserCardClass in namespace KnihovnyCz\Db\Table

Class UserCard

UserListClass in namespace KnihovnyCz\Db\Table

Class UserList

UserListCategoriesClass in namespace KnihovnyCz\Db\Table

Class UserListCategories

UserSettingsClass in namespace KnihovnyCz\Db\Table

Class UserSettings

UrlQueryHelperFactoryClass in namespace KnihovnyCz\Search\Factory

Factory to build UrlQueryHelper.

UrlQueryHelperClass in namespace KnihovnyCz\Search

VuFind Search Runner

UserSettingsServiceClass in namespace KnihovnyCz\Service

Knihovny.cz User settings service

$ UserSettingsService#userSettingsProperty in class UserSettingsService
Memory
UserSettingsServiceFactoryClass in namespace KnihovnyCz\Service

Factory for user settings restorer

UserCardsClass in namespace KnihovnyCz\View\Helper\KnihovnyCz

View helper to work with user cards

FeedbackController::updateStatusAction() — Method in class FeedbackController

Update status field of feedback message

$ NotifyCommand#urlHelperProperty in class NotifyCommand

URL helper

$ NotifyCommand#userTableProperty in class NotifyCommand

User table

$ SwitchDbHashCommand#userTableProperty in class SwitchDbHashCommand

User table gateway

GeneratorTools::updateFactory() — Method in class GeneratorTools

Given a factory method, extend the class being constructed and create a new factory for the subclass.

$ Backend#userNameProperty in class Backend

User name for EBSCO EDS API account if using UID Authentication

$ Connector#urlProperty in class Connector

URL or an array of alternative URLs of the SOLR core.

$ Connector#uniqueKeyProperty in class Connector

Solr field used to store unique identifier

UpdateDocumentClass in namespace VuFindSearch\Backend\Solr\Document

SOLR update document class.

$ SimilarBuilder#uniqueKeyProperty in class SimilarBuilder

Solr field used to store unique identifier

$ SimilarBuilder#useHandlerProperty in class SimilarBuilder

Whether to use MoreLikeThis Handler instead of the traditional MoreLikeThis component.

QueryGroup::unsetReducedHandler() — Method in class QueryGroup

Unset reduced handler.

$ ShibbolethTest#user1Property in class ShibbolethTest
$ ShibbolethTest#user2Property in class ShibbolethTest
$ ShibbolethTest#user3Property in class ShibbolethTest
UpdateDocumentTestClass in namespace VuFindTest\Backend\Solr\Document

Unit tests for SOLR update document class.

LuceneSyntaxHelperTest::unquotedNormalizationProvider() — Method in class LuceneSyntaxHelperTest

Data provider for testUnquotedNormalization

UpgradeTestClass in namespace VuFindTest\Config

Config Upgrade Test Class

UserListTestClass in namespace VuFindTest\Db\Table

UserList Test Class

UnpaywallTestClass in namespace VuFindTest\DoiLinker

Unpaywall Test Class

UserCreationTraitClass in namespace VuFindTest\Feature

Trait with utility methods for user creation/management.

UnicornMockClass in namespace VuFindTest\ILS\Driver
UnicornTestClass in namespace VuFindTest\ILS\Driver

ILS driver test

MinkTestCase::unFindCss() — Method in class MinkTestCase

Wait for an element to NOT exist.

UserIpReaderClass in namespace VuFindTest\Net

Test harness for capturing constructor parameters.

UserIpReaderFactoryTestClass in namespace VuFindTest\Net

UserIpReaderFactory Test Class

UserIpReaderTestClass in namespace VuFindTest\Net

UserIpReader Test Class

$ IdentityRepositoryTest#userBirthDateProperty in class IdentityRepositoryTest

User's birth date

RandomRecommendTest::unserializeFixture() — Method in class RandomRecommendTest

Get a fixture object

UserCommentsTestClass in namespace VuFindTest\RecordTab

UserComments Test Class

UserTestClass in namespace VuFindTest\Role\PermissionProvider

PermissionProvider User Test Class

$ UserTest#userValueMapProperty in class UserTest

User test data for testing.

SpellingProcessorTest::unserializeFixture() — Method in class SpellingProcessorTest

Get a fixture object

UrlQueryHelperTestClass in namespace VuFindTest\Search

UrlQueryHelper unit tests.

$ CursorMarkIdFetcherTest#uniqueKeyProperty in class CursorMarkIdFetcherTest

Unique key field to use in tests

$ TermsIdFetcherTest#uniqueKeyProperty in class TermsIdFetcherTest

Unique key field to use in tests

UtilsTestClass in namespace VuFindTest\Solr

Solr Utils Test Class

$ LinkifyTest#urlHighlightProperty in class LinkifyTest

Mock URL highlighter

Initializer::updateTranslator() — Method in class Initializer

Support method for setUpThemes() - add theme specific language files for translation.

$ ConcatTrait#usePipelineProperty in class ConcatTrait

Should we use the asset pipeline to join files together and minify them?

$ AbstractIlsAndUserAction#userProperty in class AbstractIlsAndUserAction

Logged in user (or false)

$ AbstractRelaisAction#userProperty in class AbstractRelaisAction

Logged-in user (or null if none)

$ CommentRecord#userProperty in class CommentRecord

Logged in user (or false)

$ DeleteRecordComment#userProperty in class DeleteRecordComment

Logged in user (or false)

$ GetRecordCover#useCoverFallbacksOnFailProperty in class GetRecordCover

If true we will render a fallback html template in case no image could be loaded

$ GetRecordTags#userProperty in class GetRecordTags

Logged in user (or false)

$ GetSaveStatuses#userProperty in class GetSaveStatuses

Logged in user (or false)

$ GetSaveStatuses#urlHelperProperty in class GetSaveStatuses

URL helper

$ TagRecord#userProperty in class TagRecord

Logged in user (or false)

AbstractBase::updatePassword() — Method in class AbstractBase

Update a user's password from the request.

ChoiceAuth::updatePassword() — Method in class ChoiceAuth

Update a user's password from the request.

$ Database#usernameProperty in class Database
Username
Database::updatePassword() — Method in class Database

Update a user's password from the request.

ILS::updatePassword() — Method in class ILS

Update a user's password from the request.

ILSAuthenticator::updateUser() — Method in class ILSAuthenticator

Update current user account with the patron information

$ Manager#userTableProperty in class Manager

Gateway to user table in database

Manager::userHasLoggedOut() — Method in class Manager

Checks whether the user has recently logged out.

Manager::updateSession() — Method in class Manager

Updates the user information in the session.

Manager::updatePassword() — Method in class Manager

Update a user's password from the request.

Manager::updateEmail() — Method in class Manager

Update a user's email from the request.

Manager::updateUser() — Method in class Manager

Update common user attributes on login

$ MultiAuth#usernameProperty in class MultiAuth

Username input

$ Shibboleth#useHeadersProperty in class Shibboleth

Read attributes from headers instead of environment variables

$ OCLCIdentities#urlProperty in class OCLCIdentities

AutoSuggest base URL

$ AlphaBrowse#urlProperty in class AlphaBrowse

URL helper

$ Facets#urlProperty in class Facets

URL helper

$ ListItems#userListProperty in class ListItems

UserList table

$ ListItems#urlProperty in class ListItems

URL helper

$ SimilarItems#urlProperty in class SimilarItems

URL helper

UpgradeClass in namespace VuFind\Config

Class to upgrade previous VuFind configurations to the current version

Upgrade::upgradeConfig() — Method in class Upgrade

Upgrade config.ini.

Upgrade::upgradeAdminPermissions() — Method in class Upgrade

Translate obsolete permission settings.

Upgrade::upgradeFacetsAndCollection() — Method in class Upgrade

Upgrade facets.ini and Collection.ini (since these are tied together).

Upgrade::upgradeAutocompleteName() — Method in class Upgrade

Update an old VuFind 1.x-style autocomplete handler name to the new style.

Upgrade::upgradeSearches() — Method in class Upgrade

Upgrade searches.ini.

Upgrade::upgradeSpellingSettings() — Method in class Upgrade

Upgrade spelling settings to account for refactoring of spelling as a recommendation module starting in release 2.4.

Upgrade::upgradeFulltext() — Method in class Upgrade

Upgrade fulltext.ini.

Upgrade::upgradeSitemap() — Method in class Upgrade

Upgrade sitemap.ini.

Upgrade::upgradeSms() — Method in class Upgrade

Upgrade sms.ini.

Upgrade::upgradeAuthority() — Method in class Upgrade

Upgrade authority.ini.

Upgrade::upgradeReserves() — Method in class Upgrade

Upgrade reserves.ini.

Upgrade::upgradeSummon() — Method in class Upgrade

Upgrade Summon.ini.

Upgrade::upgradeSummonPermissions() — Method in class Upgrade

Translate obsolete permission settings.

Upgrade::upgradePrimo() — Method in class Upgrade

Upgrade Primo.ini.

Upgrade::upgradePrimoPermissions() — Method in class Upgrade

Translate obsolete permission settings.

Upgrade::upgradePrimoServerSettings() — Method in class Upgrade

Translate obsolete server settings.

Upgrade::upgradeWorldCat() — Method in class Upgrade

Upgrade WorldCat.ini.

Upgrade::upgradeSolrMarc() — Method in class Upgrade

Upgrade SolrMarc configurations.

Upgrade::upgradeSearchSpecs() — Method in class Upgrade

Upgrade .yaml configurations.

Upgrade::upgradeILS() — Method in class Upgrade

Upgrade ILS driver configuration.

Upgrade::upgradeShardSettings() — Method in class Upgrade

Upgrade shard settings (they have moved to a different config file, so this is handled as a separate method so that all affected settings are addressed in one place.

AbstractCover::useDirectUrls() — Method in class AbstractCover

Use direct urls? (Or proxied urls)

$ AbstractSyndetics#useSSLProperty in class AbstractSyndetics

Use SSL URLs?

$ AbstractSyndetics#usePlusProperty in class AbstractSyndetics

Use Syndetics plus?

$ Booksite#urlProperty in class Booksite

Base URL for Booksite

$ Buchhandel#urlProperty in class Buchhandel

Base URL for Buchhandel

$ Orb#urlProperty in class Orb

Base URL for Orb API

$ Syndetics#useSSLProperty in class Syndetics

Use SSL URLs?

$ Booksite#urlProperty in class Booksite

Base URL for Booksite

$ AlmaController#userTableProperty in class AlmaController

User table

CoverController::unavailableAction() — Method in class CoverController

Return the default 'image not found' information

ErrorController::unavailableAction() — Method in class ErrorController

Display unavailable message.

MyResearchController::userloginAction() — Method in class MyResearchController

User login action -- clear any previous follow-up information prior to triggering a login process. This is used for explicit login links within the UI to differentiate them from contextual login links that are triggered by attempting to access protected actions.

MyResearchController::unsubscribeAction() — Method in class MyResearchController

Unsubscribe a scheduled alert for a saved search.

OAuth2Controller::userInfoAction() — Method in class OAuth2Controller

OpenID Connect user info request action

DbUpgrade::updateModifiedColumns() — Method in class DbUpgrade

Modify columns based on the output of getModifiedColumns().

DbUpgrade::updateModifiedConstraints() — Method in class DbUpgrade

Modify constraints based on the output of getModifiedConstraints().

DbUpgrade::updateModifiedKeys() — Method in class DbUpgrade

Update keys based on the output of getModifiedKeys().

$ Reserves#useIndexProperty in class Reserves

Do we need to use the Solr index for reserves (true) or the ILS driver (false)?

Reserves::useIndex() — Method in class Reserves

Do we need to use the Solr index for reserves (true) or the ILS driver (false)?

QRCodeController::unavailableAction() — Method in class QRCodeController

Return the default 'qrcode not found' information

UpgradeControllerClass in namespace VuFind\Controller

Class controls VuFind upgrading.

UpgradeController::upgradeMySQL() — Method in class UpgradeController

Attempt to perform a MySQL upgrade; return either a string containing SQL (if we are in "log SQL" mode), an empty string (if we are successful but not logging SQL) or a Laminas object representing forward/redirect (if we need to obtain user input).

UpgradeControllerFactoryClass in namespace VuFind\Controller

Upgrade controller factory.

$ Loader#upcProperty in class Loader

User UPC number parameter

$ Loader#uuidProperty in class Loader

User UUID parameter

$ Search#user_idProperty in class Search
UserClass in namespace VuFind\Db\Row

Row Definition for user

$ User#usernameProperty in class User
$ User#user_provided_emailProperty in class User
User::updateLibraryCardEntry() — Method in class User

Verify that the current card information exists in user's library cards (if enabled) and is up to date.

User::updateHash() — Method in class User

Update the verification hash for this user

User::updateLastLanguage() — Method in class User

Updated saved language

User::updateEmail() — Method in class User

Update the user's email address, if appropriate. Note that this does NOT automatically save the row; it assumes a subsequent call will be made to the save() method.

UserCardClass in namespace VuFind\Db\Row

Row Definition for user_card

$ UserCard#user_idProperty in class UserCard
UserFactoryClass in namespace VuFind\Db\Row

User row gateway factory.

UserListClass in namespace VuFind\Db\Row

Row Definition for user_list

$ UserList#user_idProperty in class UserList
UserList::updateFromRequest() — Method in class UserList

Update and save the list object using a request object -- useful for sharing form processing between multiple actions.

UserListFactoryClass in namespace VuFind\Db\Row

UserList row gateway factory.

UserResourceClass in namespace VuFind\Db\Row

Row Definition for user_resource

Record::updateRecord() — Method in class Record

Update an existing entry in the record table or create a new one

Resource::updateRecordId() — Method in class Resource

Update the database to reflect a changed record identifier.

UserClass in namespace VuFind\Db\Table

Table Definition for user

UserCardClass in namespace VuFind\Db\Table

Table Definition for user_card

UserFactoryClass in namespace VuFind\Db\Table

User table gateway factory.

UserListClass in namespace VuFind\Db\Table

Table Definition for user_list

UserListFactoryClass in namespace VuFind\Db\Table

UserList table gateway factory.

UserResourceClass in namespace VuFind\Db\Table

Table Definition for user_resource

UnpaywallClass in namespace VuFind\DoiLinker

Unpaywall DOI linker

UnpaywallFactoryClass in namespace VuFind\DoiLinker

BrowZine DOI linker factory

$ AuthEmailNotVerified#userProperty in class AuthEmailNotVerified

User object with unverified email.

$ HttpDownloadException#urlProperty in class HttpDownloadException

URL we tried to download.

$ FavoritesService#userListTableProperty in class FavoritesService

UserList database table

Form::useCaptcha() — Method in class Form

Check if the form should use Captcha validation (if supported)

$ Aleph#useradmProperty in class Aleph

User library

Alma::updateHolds() — Method in class Alma

Update holds

Demo::updateHolds() — Method in class Demo

Update holds

$ KohaRest#useHomeLibraryProperty in class KohaRest

Whether to display home library instead of holding library

KohaRest::updateHolds() — Method in class KohaRest

Update holds

SierraRest::updateHolds() — Method in class SierraRest

Update holds

UnicornClass in namespace VuFind\ILS\Driver

SirsiDynix Unicorn ILS Driver (VuFind side)

$ Unicorn#urlProperty in class Unicorn

Full URL to API (alternative to host/port/search_prog)

UnicornFactoryClass in namespace VuFind\ILS\Driver

Class UnicornFactory

$ Voyager#useHoldingsSortGroupsProperty in class Voyager

Whether to use holdings sort groups to sort holdings records

$ XCNCIP2#urlProperty in class XCNCIP2

NCIP server URL

$ XCNCIP2#useOAuth2Property in class XCNCIP2

If the NCIP need an authorization using OAuth2

$ XCNCIP2#useHttpBasicProperty in class XCNCIP2

If the NCIP need an authorization using HTTP Basic

$ XCNCIP2#usernameProperty in class XCNCIP2

HTTP Basic username

$ Logger#userIpReaderProperty in class Logger

User IP address reader

$ Post#urlProperty in class Post

Holds the verbosity level

$ Slack#usernameProperty in class Slack

The slack username messages are posted under.

UserIpReaderClass in namespace VuFind\Net

Service to retrieve user IP address.

UserIpReaderFactoryClass in namespace VuFind\Net

Factory for instantiating UserIpReader.

$ Server#useCursorMarkProperty in class Server

Should we use cursorMarks for Solr retrieval? Normally this is the best option, but it is incompatible with some other Solr features and may need to be disabled in rare circumstances (e.g. when using field collapsing/ result grouping).

Server::unexpectedError() — Method in class Server

Die with an unexpected error code (when something outside the scope of OAI-PMH fails).

UserEntityClass in namespace VuFind\OAuth2\Entity

OAuth2 user entity implementation.

$ UserEntity#userProperty in class UserEntity
User
$ IdentityRepository#userTableProperty in class IdentityRepository

User table

$ AuthorInfo#useViafProperty in class AuthorInfo

Should we use VIAF for authorized names?

$ SolrMarcRemote#uriPatternProperty in class SolrMarcRemote

Holds the URI-Pattern of the service that returns the marc binary blob by id

UserCommentsClass in namespace VuFind\RecordTab

User comments tab

$ UserComments#useCaptchaProperty in class UserComments

Should we use Captcha?

UserCommentsFactoryClass in namespace VuFind\RecordTab

Factory for building the UserComments tab.

$ Checklist#uncheckedProperty in class Checklist

Unchecked values

Checklist::uncheck() — Method in class Checklist

Uncheck a value, returning true if the value was found in the checked list and false if it was not.

AbstractFallbackLoader::updateRecord() — Method in class AbstractFallbackLoader

When a record ID has changed, update the record driver and database to reflect the changes.

$ Jop#userIpReaderProperty in class Jop

User IP address reader

$ IpRange#userIpReaderProperty in class IpRange

User IP address reader

$ IpRegEx#userIpReaderProperty in class IpRegEx

User IP address reader

UserClass in namespace VuFind\Role\PermissionProvider

LDAP permission provider for VuFind.

UsernameClass in namespace VuFind\Role\PermissionProvider

Username permission provider for VuFind.

$ Results#urlQueryHelperFactoryProperty in class Results

URL query helper factory

Results::updateSaveStatus() — Method in class Results

Given a database row corresponding to the current search object, mark whether this search is saved and what its database ID is.

$ Params#unsupportedFiltersProperty in class Params

Current filters not supported by a backend

$ AbstractSolrBackendFactory#uniqueKeyProperty in class AbstractSolrBackendFactory

Solr field used to store unique identifiers

UrlQueryHelperFactoryClass in namespace VuFind\Search\Factory

Factory to build UrlQueryHelper.

$ Results#userProperty in class Results

Object if user is logged in, false otherwise.

$ NormalizedSearch#urlProperty in class NormalizedSearch

Search URL from normalized search object

HierarchicalFacetHelper::updateAppliedChildrenStatus() — Method in class HierarchicalFacetHelper

Update 'opened' of all facet items

$ Options#useSolrSearchOptionsProperty in class Options

Should we load Solr search options for a more integrated search experience or omit them to prevent confusion in multi-backend environments?

UrlQueryHelperClass in namespace VuFind\Search

Class to help build URLs and forms in the view based on search settings.

$ UrlQueryHelper#urlParamsProperty in class UrlQueryHelper

URL query parameters

UrlQueryHelper::updateQueryString() — Method in class UrlQueryHelper

Generic case of parameter rebuilding.

$ AbstractFile#urlsProperty in class AbstractFile

URLs in map.

UtilsClass in namespace VuFind\Solr

Solr Utility Functions

UrlShortenerInterfaceClass in namespace VuFind\UrlShortener

URL shortener interface.

$ AlphaBrowse#urlProperty in class AlphaBrowse

URL helper

$ Citation#uncappedWordsProperty in class Citation

List of words to never capitalize when using title case.

$ Citation#uncappedPhrasesProperty in class Citation

List of multi-word phrases to never capitalize when using title case.

$ GoogleAnalytics#universalProperty in class GoogleAnalytics

Are we using Universal Analytics?

$ Linkify#urlHighlightProperty in class Linkify

Url highlighter

$ Matomo#urlProperty in class Matomo

Matomo URL (empty if disabled)

$ Piwik#urlProperty in class Piwik

Piwik URL (false if disabled)

$ SearchTabs#urlProperty in class SearchTabs
Url
UrlClass in namespace VuFind\View\Helper\Root

Url view helper (extending core Laminas helper with additional functionality)

UrlFactoryClass in namespace VuFind\View\Helper\Root

Url helper factory.

UserListClass in namespace VuFind\View\Helper\Root

List view helper

UserListFactoryClass in namespace VuFind\View\Helper\Root

UserList helper factory.

UserTagsClass in namespace VuFind\View\Helper\Root

Tag view helper

UserTagsFactoryClass in namespace VuFind\View\Helper\Root

UserTags helper factory.

V

Holds::validateIds() — Method in class Holds

Validate supplied IDs against remembered IDs. Returns true if all supplied IDs are remembered, otherwise returns false.

$ User#verify_hashProperty in class User
JsonListener::value() — Method in class JsonListener

Process value

$ NullSessionManager#validatorChainProperty in class NullSessionManager

Validation chain to determine if session is valid

$ SparqlService#versionProperty in class SparqlService
$ SparqlService#vufindVersionProperty in class SparqlService
AbstractAdmin::validateAccessPermission() — Method in class AbstractAdmin

Use preDispatch event to block access when appropriate.

InstallCommand::validateBasePath() — Method in class InstallCommand

Validate a base path. Returns true on success, message on failure.

InstallCommand::validateModules() — Method in class InstallCommand

Validate a comma-separated list of module names. Returns true on success, message on failure.

InstallCommand::validateModule() — Method in class InstallCommand

Validate the custom module name. Returns true on success, message on failure.

InstallCommand::validateHost() — Method in class InstallCommand

Validate the user's hostname input. Returns true on success, message on failure.

NotifyCommand::validateSchedule() — Method in class NotifyCommand

Validate the schedule (return true if we should send a message).

$ SearchRequestModel#viewProperty in class SearchRequestModel

Requested level of detail to return the results with

NamedList::valid() — Method in class NamedList

Return true if the iterator is at a valid position.

AbstractBase::validateBackend() — Method in class AbstractBase

Validate that the provided backend matches the expected target identifier.

AbstractRecordCollection::valid() — Method in class AbstractRecordCollection

Return true if current collection index is valid.

$ AbstractExpireCommandTest#validTableClassProperty in class AbstractExpireCommandTest

Name of a valid table class to test with

$ ExpireAuthHashesCommandTest#validTableClassProperty in class ExpireAuthHashesCommandTest

Name of a valid table class to test with

$ ExpireExternalSessionsCommandTest#validTableClassProperty in class ExpireExternalSessionsCommandTest

Name of a valid table class to test with

$ ExpireSearchesCommandTest#validTableClassProperty in class ExpireSearchesCommandTest

Name of a valid table class to test with

$ ExpireSessionsCommandTest#validTableClassProperty in class ExpireSessionsCommandTest

Name of a valid table class to test with

VersionTestClass in namespace VuFindTest\Config

Version Reader Test Class

ViewTraitClass in namespace VuFindTest\Feature

Trait for tests involving Laminas Views.

$ PAIATest#validConfigProperty in class PAIATest
VirtuaTestClass in namespace VuFindTest\ILS\Driver

ILS driver test

Voyager2MockClass in namespace VuFindTest\ILS\Driver
VoyagerMockClass in namespace VuFindTest\ILS\Driver
VoyagerNoSupportMockClass in namespace VuFindTest\ILS\Driver
VoyagerRestfulTestClass in namespace VuFindTest\ILS\Driver

ILS driver test

VoyagerTestClass in namespace VuFindTest\ILS\Driver

ILS driver test

CallnumberBrowseTest::validateSetting() — Method in class CallnumberBrowseTest

Sets callnumber_handler to true

VisualizationTestClass in namespace VuFindTest\Mink

Mink test class for visualization view.

$ VisualizationTest#visualConfigProperty in class VisualizationTest

Config overrides for visual facets.

VersionsTestClass in namespace VuFindTest\RecordTab

Versions Test Class

VuFindHighlighterTestClass in namespace VuFindTest\UrlHighlight

VuFindHighlighter Test Class

MakeTagTest::voidTags() — Method in class MakeTagTest
MakeTagTest::validTags() — Method in class MakeTagTest
VuFindGeoTestClass in namespace VuFindTest\XSLT\Import

XSLT geographic helper tests.

VuFindTestClass in namespace VuFindTest\XSLT\Import

XSLT helper tests.

VuFindWorkKeysTestClass in namespace VuFindTest\XSLT\Import

XSLT helper tests for VuFindWorkKeys.

$ DoiLookup#viewRendererProperty in class DoiLookup

View renderer

AbstractBase::validateConfig() — Method in class AbstractBase

Validate configuration parameters. This is a support method for getConfig(), so the configuration MUST be accessed using $this->config; do not call $this->getConfig() from within this method!

AbstractBase::validateCredentials() — Method in class AbstractBase

Validate the credentials in the provided request, but do not change the state of the current logged-in user. Return true for valid credentials, false otherwise.

AbstractBase::validateUsernameAgainstPolicy() — Method in class AbstractBase

Verify that a username fulfills the username policy. Throws exception if the usernmae is invalid.

AbstractBase::validatePasswordAgainstPolicy() — Method in class AbstractBase

Verify that a password fulfills the password policy. Throws exception if the password is invalid.

AbstractBase::validateStringAgainstPolicy() — Method in class AbstractBase

Verify that a username or password fulfills the given policy. Throws exception if the string is invalid.

CAS::validateConfig() — Method in class CAS

Validate configuration parameters. This is a support method for getConfig(), so the configuration MUST be accessed using $this->config; do not call $this->getConfig() from within this method!

ChoiceAuth::validateConfig() — Method in class ChoiceAuth

Validate configuration parameters. This is a support method for getConfig(), so the configuration MUST be accessed using $this->config; do not call $this->getConfig() from within this method!

ChoiceAuth::validateCredentials() — Method in class ChoiceAuth

Validate the credentials in the provided request, but do not change the state of the current logged-in user. Return true for valid credentials, false otherwise.

Database::validateUsername() — Method in class Database

Make sure username isn't blank and matches the policy.

Database::validatePassword() — Method in class Database

Make sure password isn't blank, matches the policy and passwords match.

Database::validateParams() — Method in class Database

Validate parameters.

$ EmailAuthenticator#viewRendererProperty in class EmailAuthenticator

View Renderer

Facebook::validateConfig() — Method in class Facebook

Validate configuration parameters. This is a support method for getConfig(), so the configuration MUST be accessed using $this->config; do not call $this->getConfig() from within this method!

ILS::validatePasswordUpdate() — Method in class ILS

Make sure passwords match and fulfill ILS policy

LDAP::validateConfig() — Method in class LDAP

Validate configuration parameters. This is a support method for getConfig(), so the configuration MUST be accessed using $this->config; do not call $this->getConfig() from within this method!

LDAP::validateCredentialsInLdap() — Method in class LDAP

Validate credentials

Manager::validateCredentials() — Method in class Manager

Validate the credentials in the provided request, but do not change the state of the current logged-in user. Return true for valid credentials, false otherwise.

MultiAuth::validateConfig() — Method in class MultiAuth

Validate configuration parameters. This is a support method for getConfig(), so the configuration MUST be accessed using $this->config; do not call $this->getConfig() from within this method!

Shibboleth::validateConfig() — Method in class Shibboleth

Validate configuration parameters. This is a support method for getConfig(), so the configuration MUST be accessed using $this->config; do not call $this->getConfig() from within this method!

AbstractBase::verify() — Method in class AbstractBase

Pull the captcha field from controller params and check them for accuracy

Demo::verify() — Method in class Demo

Pull the captcha field from controller params and check them for accuracy

Interval::verify() — Method in class Interval

Pull the captcha field from controller params and check them for accuracy

LaminasBase::verify() — Method in class LaminasBase

Pull the captcha field from controller params and check them for accuracy

ReCaptcha::verify() — Method in class ReCaptcha

Pull the captcha field from controller params and check them for accuracy

PluginManager::validate() — Method in class PluginManager

Validate the plugin

VersionClass in namespace VuFind\Config

Version check utility

AbstractBase::validateAccessPermission() — Method in class AbstractBase

Use preDispatch event to block access when appropriate.

RecordVersionsSearchTrait::versionsAction() — Method in class RecordVersionsSearchTrait

Show results of versions search.

InstallController::validateAutoConfigureConfig() — Method in class InstallController

Use preDispatch event to block access when appropriate.

MyResearchController::verifyAction() — Method in class MyResearchController

Receive a hash and display the new password form if it's valid

MyResearchController::verifyEmailAction() — Method in class MyResearchController

Receive a hash and display the new password form if it's valid

AbstractRequestBase::validateIds() — Method in class AbstractRequestBase

Validate supplied IDs against remembered IDs. Returns true if all supplied IDs are remembered, otherwise returns false.

AbstractRequestBase::validateRequest() — Method in class AbstractRequestBase

Method for validating contents of a request; returns an array of collected details if request is valid, otherwise returns false.

AbstractRequestBase::validatePickUpInput() — Method in class AbstractRequestBase

Check if the user-provided pickup location is valid.

AbstractRequestBase::validatePickUpLocation() — Method in class AbstractRequestBase

Check if the provided pickup location is valid.

AbstractRequestBase::validateRequestGroupInput() — Method in class AbstractRequestBase

Check if the user-provided request group is valid.

AbstractRequestBase::validateRequestGroup() — Method in class AbstractRequestBase

Check if the provided request group is valid.

Captcha::verify() — Method in class Captcha

Pull the captcha field from controller params and check them for accuracy

Holds::validateDates() — Method in class Holds

Check if the user-provided dates are valid.

Holds::validateFrozenThrough() — Method in class Holds

Check if the user-provided "frozen through" date is valid.

UpgradeController::validateAutoConfigureConfig() — Method in class UpgradeController

Use preDispatch event to block access when appropriate.

$ Loader#validSizesProperty in class Loader

Valid image sizes to request

Loader::validateAndMoveTempFile() — Method in class Loader

This method either moves the temporary file to its final location (true) or detects an error and deletes it (false).

$ User#verify_hashProperty in class User
$ Form#vufindConfigProperty in class Form

VuFind main configuration

$ Form#viewHelperManagerProperty in class Form

View helper manager.

$ Email#viewRendererProperty in class Email

View renderer

GeniePlus::validateConfiguration() — Method in class GeniePlus

Support method for init(): make sure we have a valid configuration.

$ Koha#validatePasswordsProperty in class Koha

Should we validate passwords against Koha system?

$ KohaILSDI#validatePasswordsProperty in class KohaILSDI

Should validate passwords against Koha system?

$ SierraRest#validHoldStatusesProperty in class SierraRest

Item statuses that allow placing a hold

SierraRest::validatePatron() — Method in class SierraRest

Perform extra validation of retrieved user, if configured to do so. Returns patron data if value, null otherwise.

VirtuaClass in namespace VuFind\ILS\Driver

VTLS Virtua Driver

VoyagerClass in namespace VuFind\ILS\Driver

Voyager ILS Driver

VoyagerRestfulClass in namespace VuFind\ILS\Driver

Voyager Restful ILS Driver

VoyagerRestfulFactoryClass in namespace VuFind\ILS\Driver

Factory for VoyagerRestful ILS driver.

PaginationHelper::validateSort() — Method in class PaginationHelper

Support method for getPagingSetup() -- validate the active sort option, returning either a valid sort method or false.

VerbosityTraitClass in namespace VuFind\Log\Writer

Trait to add configurable verbosity settings to loggers

$ VerbosityTrait#verbosityProperty in class VerbosityTrait

Holds the verbosity level

$ AbstractBase#vocabFieldToGenericFieldsMapProperty in class AbstractBase

This varriable can be overwritten by child classes to define which custom field is filled by which generic fields.

$ BEPress#vocabFieldToGenericFieldsMapProperty in class BEPress

Mapping from BEPress to VuFind fields; see http:// div.div1.com.au/div-thoughts/div-commentaries/66-div-commentary-metadata

$ DublinCore#vocabFieldToGenericFieldsMapProperty in class DublinCore

Mapping from Dublin Core to VuFind fields

$ Eprints#vocabFieldToGenericFieldsMapProperty in class Eprints

Mapping from Eprints to VuFind fields

$ HighwirePress#vocabFieldToGenericFieldsMapProperty in class HighwirePress

Mapping from Highwire Press to VuFind fields; see https://jira.duraspace.org/secure/attachment/13020/Invisible_institutional.pdf

$ PRISM#vocabFieldToGenericFieldsMapProperty in class PRISM

Mapping from Highwire Press to VuFind fields see https://www.idealliance.org/prism-metadata

$ Server#vufindApiFieldsProperty in class Server

Fields to return when the 'vufind' format is requested. Empty array means the format is disabled.

ClientRepository::validateClient() — Method in class ClientRepository

Validate a client's secret.

VisualFacetsClass in namespace VuFind\Recommend

VisualFacets Recommendations Module

VersionAwareInterfaceClass in namespace VuFind\RecordDriver\Feature

Version aware marker interface.

VersionAwareTraitClass in namespace VuFind\RecordDriver\Feature

Logic for record versions support.

SolrMarcRemote::verifyFullRecordIsAvailable() — Method in class SolrMarcRemote

Load the fullrecord field if not already loaded

VersionsClass in namespace VuFind\RecordTab

Versions tab

VersionsFactoryClass in namespace VuFind\RecordTab

Factory for building the Versions tab.

$ Options#viewOptionsProperty in class Options

Available view options

$ Options#visibleShardCheckboxesProperty in class Options

Should we present shard checkboxes to the user?

$ Params#viewProperty in class Params
View
ViewOptionsTraitClass in namespace VuFind\Search\Options

Trait for setting up view options. Designed to be included in a subclass of \VuFind\Search\Base\Options.

AbstractPluginManager::validate() — Method in class AbstractPluginManager

Validate the plugin

$ Generator#verboseProperty in class Generator

Verbose callback

Generator::verboseMsg() — Method in class Generator

Write a verbose message (if configured to do so)

$ AbstractGeneratorPlugin#verboseMessageCallbackProperty in class AbstractGeneratorPlugin

Verbose message callback

AbstractGeneratorPlugin::verboseMsg() — Method in class AbstractGeneratorPlugin

Write a verbose message (if callback is available and configured to do so)

VuFindHighlighterClass in namespace VuFind\UrlHighlight

Provide URL formatted as HTML and prefixed with proxy if applicable

$ AbstractJsStrings#varNameProperty in class AbstractJsStrings

Variable name to store values

$ MakeTag#validBodyTagsProperty in class MakeTag

List of all valid body tags

$ MakeTag#voidElementsProperty in class MakeTag

List of all void tags (tags that access no innerHTML)

MakeTag::verifyTagName() — Method in class MakeTag

Verify HTML tag matches HTML spec

VuFindClass in namespace VuFind\XSLT\Import

XSLT support class -- all methods of this class must be public and static; they will be automatically made available to your XSL stylesheet for use with the php:function() function.

VuFindGeoClass in namespace VuFind\XSLT\Import

XSLT importer support methods for geographic indexing.

VuFindGeo::validateNumericCoordinates() — Method in class VuFindGeo

Return true if the coordinate set is complete and numeric.

VuFindGeo::validateLines() — Method in class VuFindGeo

Check decimal degree coordinates to make sure they do not form a line at the poles.

VuFindGeo::validateExtent() — Method in class VuFindGeo

Check decimal degree coordinates to make sure they are within map extent.

VuFindGeo::validateNorthSouth() — Method in class VuFindGeo

Check decimal degree coordinates to make sure that north is not less than south.

VuFindGeo::validateEastWest() — Method in class VuFindGeo

Check decimal degree coordinates to make sure that east is not less than west.

VuFindGeo::validateCoordinateDistance() — Method in class VuFindGeo

Check decimal degree coordinates to make sure they are not too close.

VuFindGeo::validateCoverageCoordinates() — Method in class VuFindGeo

Return true if the coordinate set is valid for inclusion in VuFind's index.

VuFindSitemapClass in namespace VuFind\XSLT\Import

XSLT support class -- all methods of this class must be public and static; they will be automatically made available to your XSL stylesheet for use with the php:function() function.

VuFindWorkKeysClass in namespace VuFind\XSLT\Import

XSLT importer support methods for work key generation.

W

WayfControllerClass in namespace KnihovnyCz\Controller

Class WayfController

WikidataTraitClass in namespace KnihovnyCz\RecordDriver\Feature

Trait WikidataTrait

$ SolrAuthority#wikiExternalLinksProperty in class SolrAuthority
$ SolrAuthority#wikiSiteLinksProperty in class SolrAuthority
$ SolrLibrary#wikiExternalLinksProperty in class SolrLibrary
WayfFilterGeneratorClass in namespace KnihovnyCz\Service

Class WayfFilterGenerator

WayfFilterGeneratorFactoryClass in namespace KnihovnyCz\Service

Class WayfFilterGeneratorFactory

NullSessionManager::writeClose() — Method in class NullSessionManager

Write session to save handler and close

WebApiControllerClass in namespace VuFindApi\Controller

Web API Controller

WebApiControllerFactoryClass in namespace VuFindApi\Controller

Factory for WebApiController.

WebRecordFormatterClass in namespace VuFindApi\Formatter

Record formatter for web API responses

WebRecordFormatterFactoryClass in namespace VuFindApi\Formatter

Web Record Formatter factory.

WebCrawlCommandClass in namespace VuFindConsole\Command\Import

Console command: web crawler

WebCrawlCommandFactoryClass in namespace VuFindConsole\Command\Import

Factory for web crawl command.

InstallCommand::writeFileToDisk() — Method in class InstallCommand

Write file contents to disk.

DeleteCommand::writeFileToDisk() — Method in class DeleteCommand

Write file contents to disk.

NotifyCommand::warn() — Method in class NotifyCommand

Display a warning.

DedupeCommand::writeToOutputFile() — Method in class DedupeCommand

Write a line to an output file.

SuppressedCommand::writeToDisk() — Method in class SuppressedCommand

Write content to disk.

ConsoleOutputTrait::writeln() — Method in class ConsoleOutputTrait

Write a line to the output (if available). Implements a fluent interface.

GeneratorTools::writeClass() — Method in class GeneratorTools

Write a class to disk.

GeneratorTools::writeModuleConfig() — Method in class GeneratorTools

Write a module configuration.

GeneratorTools::writeNewConfigs() — Method in class GeneratorTools

Update the configuration of a target module with multiple settings.

GeneratorTools::writeNewConfig() — Method in class GeneratorTools

Update the configuration of a target module with a single setting.

Backend::workExpressions() — Method in class Backend

Return work expressions.

Backend::writeDocument() — Method in class Backend

Write a document to Solr. Return an array of details about the updated index.

WriteDocumentCommandClass in namespace VuFindSearch\Backend\Solr\Command

Command to write a document object to Solr.

Connector::write() — Method in class Connector

Write to the SOLR index.

$ OptimizeDocument#waitFlushProperty in class OptimizeDocument

Value for waitFlush attribute

$ OptimizeDocument#waitSearcherProperty in class OptimizeDocument

Value for waitSearch attribute

$ Connector#wskeyProperty in class Connector

OCLC API key

WorkExpressionsCommandClass in namespace VuFindSearch\Command

Return work expressions command.

$ WorkExpressionsCommand#workKeysProperty in class WorkExpressionsCommand

Work identification keys.

WorkExpressionsInterfaceClass in namespace VuFindSearch\Feature

Work expressions feature interface definition.

WorkExpressionsInterface::workExpressions() — Method in class WorkExpressionsInterface

Return work expressions.

WriteDocumentCommandTestClass in namespace VuFindTest\Backend\Solr\Command

Unit tests for WriteDocumentCommand.

WebCrawlCommandTestClass in namespace VuFindTest\Command\Import

Import/WebCrawl command test.

WorkExpressionsCommandTestClass in namespace VuFindTest\Command

Unit tests for WorkExpressionsCommand.

WriterTestClass in namespace VuFindTest\Config

Config Writer Test Class

WikipediaTestClass in namespace VuFindTest\Connection

Unit tests for Wikipedia connector.

WorldCatUtilsTestClass in namespace VuFindTest\Connection

Unit tests for WorldCat utility connector.

MinkTestCase::waitStatement() — Method in class MinkTestCase

Wait for a JavaScript statement to result in true.

MinkTestCase::waitForPageLoad() — Method in class MinkTestCase

Wait for page load (full page or any element) to complete

MinkTestCase::waitForLightboxHidden() — Method in class MinkTestCase

Wait for Lightbox to become hidden if it isn't already.

WebResultsTestClass in namespace VuFindTest\Recommend

WebResults Test Class

WorldCatTestClass in namespace VuFindTest\RecordDriver

WorldCat Record Driver Test Class

WorldCatSimilarTestClass in namespace VuFindTest\Related

WorldCat Similar Related Items Test Class

WriterTestClass in namespace VuFindTest\Solr

Solr Utils Test Class

Importer::writeData() — Method in class Importer

Write a batch of JSON data to Solr.

$ Upgrade#warningsProperty in class Upgrade

Warnings generated during upgrade process

WriterClass in namespace VuFind\Config

Class to update VuFind configuration settings

WikipediaClass in namespace VuFind\Connection

Wikipedia connection class

WorldCatUtilsClass in namespace VuFind\Connection

World Cat Utilities

WorldCatUtilsFactoryClass in namespace VuFind\Connection

WorldCat utils factory.

AlmaController::webhookAction() — Method in class AlmaController

Action that is executed when the webhook page is called.

AlmaController::webhookUser() — Method in class AlmaController

Webhook actions related to a newly created, updated or deleted user in Alma.

AlmaController::webhookChallenge() — Method in class AlmaController

The webhook challenge. This is used to activate the webhook in Alma. Without activating it, Alma will not send its webhook messages to VuFind.

AlmaController::webhookNotImplemented() — Method in class AlmaController

A default message to be sent back to Alma if an action for a certain webhook type is not implemented (yet).

WebControllerClass in namespace VuFind\Controller

Web Controller

WorldcatControllerClass in namespace VuFind\Controller

WorldCat Controller

WorldcatrecordControllerClass in namespace VuFind\Controller

WorldCat Record Controller

Session::writeSession() — Method in class Session

Store data for the given session ID.

$ Aleph#wwwuserProperty in class Aleph

X server user name

$ Aleph#wwwpasswdProperty in class Aleph

X server user password

$ HorizonXMLAPI#wsProfileProperty in class HorizonXMLAPI

API profile

$ HorizonXMLAPI#wsURLProperty in class HorizonXMLAPI

API URL

$ HorizonXMLAPI#wsPickUpLocationsProperty in class HorizonXMLAPI

Available pickup locations for holds

$ HorizonXMLAPI#wsDefaultPickUpLocationProperty in class HorizonXMLAPI

Defaut pickup location for holds

$ HorizonXMLAPI#wsDateFormatProperty in class HorizonXMLAPI

Date format used by API

$ Polaris#ws_hostProperty in class Polaris

Web services host

$ Polaris#ws_appProperty in class Polaris

Web services application path

$ Polaris#ws_api_idProperty in class Polaris

Web services ID

$ Polaris#ws_api_keyProperty in class Polaris

Web services key

$ Polaris#ws_requestingorgidProperty in class Polaris

Web services requesting organization ID

$ VoyagerRestful#ws_hostProperty in class VoyagerRestful

Web services host

$ VoyagerRestful#ws_portProperty in class VoyagerRestful

Web services port

$ VoyagerRestful#ws_appProperty in class VoyagerRestful

Web services app

$ VoyagerRestful#ws_dbKeyProperty in class VoyagerRestful

Web services database key

$ VoyagerRestful#ws_patronHomeUbIdProperty in class VoyagerRestful

Web services patron home UB ID

$ VoyagerRestful#ws_pickUpLocationsProperty in class VoyagerRestful

Legal pickup locations

$ AuthorInfo#wikipediaProperty in class AuthorInfo

Wikipedia client

WebResultsClass in namespace VuFind\Recommend

WebResults Recommendations Module

WorldCatIdentitiesClass in namespace VuFind\Recommend

WorldCatIdentities Recommendations Module

$ WorldCatIdentities#worldCatUtilsProperty in class WorldCatIdentities

WorldCat utilities wrapper object.

WorldCatIdentitiesFactoryClass in namespace VuFind\Recommend

WorldCatIdentities recommendation module factory.

WorldCatClass in namespace VuFind\RecordDriver

Model for MARC records in WorldCat.

WorldCatSimilarClass in namespace VuFind\Related

Related Records: WorldCat-based similarity

WorldCatBackendFactoryClass in namespace VuFind\Search\Factory

Factory for WorldCat backends.

$ WorldCatBackendFactory#wcConfigProperty in class WorldCatBackendFactory

WorldCat configuration

$ AbstractBase#writesDisabledProperty in class AbstractBase

Whether writes are disabled, i.e. any changes to the session are not written to the storage

AbstractBase::write() — Method in class AbstractBase

Write function that is called when session data is to be saved.

SecureDelegator::write() — Method in class SecureDelegator

Writes session data.

AbstractFile::write() — Method in class AbstractFile

Write the map to a file on disk.

$ Generator#warningsProperty in class Generator

Warnings thrown during sitemap generation

WriterClass in namespace VuFind\Solr

Solr Writer service

Writer::write() — Method in class Writer

Write a document to the search service. Return the result array from the command.

WriterFactoryClass in namespace VuFind\Solr

Solr writer factory.

$ HelpText#warningsProperty in class HelpText

Warning messages

X

XCNCIP2TestClass in namespace KnihovnyCzTest\ILS\Driver
XCNCIP2Class in namespace KnihovnyCz\ILS\Driver

Class XCNCIP2

$ SolrDublinCore#xmlCacheProperty in class SolrDublinCore

Parsed XML

$ Record#xmlProperty in class Record

XML record.

XCNCIP2TestClass in namespace VuFindTest\ILS\Driver

ILS driver test

AbstractSyndetics::xmlToDOMDocument() — Method in class AbstractSyndetics

Turn an XML response into a DOMDocument object.

XmlClass in namespace VuFind\Hierarchy\TreeDataFormatter

Hierarchy Tree Data Formatter (XML)

XMLFileClass in namespace VuFind\Hierarchy\TreeDataSource

Hierarchy Tree Data Source (XML File)

$ Aleph#xserver_enabledProperty in class Aleph

Is X server enabled?

$ Aleph#xportProperty in class Aleph

X server port (defaults to 80)

$ AlephRestfulException#xmlResponseProperty in class AlephRestfulException

XML response (false for none)

XCNCIP2Class in namespace VuFind\ILS\Driver

XC NCIP Toolkit (v2) ILS Driver

XCNCIP2FactoryClass in namespace VuFind\ILS\Driver

Factory for XCNCIP2 ILS driver.

$ MarcAdvancedTrait#xmlTypeProperty in class MarcAdvancedTrait

Type to export in getXML().

Pazpar2::xmlToArray() — Method in class Pazpar2

Converts a SimpleXMLElement to an array

$ Jop#xpathTitleSelectorProperty in class Jop

As the JOP resolver provides also generic labels 'Article', 'Journal' etc. in element AccessLevel this label can be used as title for resolver results by setting this variable to 'AccessLevel'

$ Sitemap#xhtmlNamespaceNeededProperty in class Sitemap

Whether the XHTML namespace is needed

VuFind::xmlAsText() — Method in class VuFind

Convert provided nodes into XML and return as text. This is useful for populating the fullrecord field with the raw input XML.

Y

YamlReaderTestClass in namespace VuFindTest\Config

Config YamlReader Test Class

YamlReaderClass in namespace VuFind\Config

VuFind YAML Configuration Reader

YamlReaderFactoryClass in namespace VuFind\Config

Factory for YamlReader (and subclasses).

$ Resource#yearProperty in class Resource
$ Form#yamlReaderProperty in class Form

YAML reader

Z

$ GetZiskejEddFee#ziskejApiProperty in class GetZiskejEddFee

Ziskej API

ZiskejAdminControllerClass in namespace KnihovnyCz\Controller

Class ZiskejAdminController

ZiskejControllerClass in namespace KnihovnyCz\Controller

Class ZiskejController

ZiskejEddTraitClass in namespace KnihovnyCz\Controller

Ziskej EDD trait

ZiskejEddTrait::ziskejEddOrderAction() — Method in class ZiskejEddTrait

Ziskej EDD order action

ZiskejEddTrait::ziskejEddOrderPostAction() — Method in class ZiskejEddTrait

Send Ziskej EDD order form

ZiskejMvsTraitClass in namespace KnihovnyCz\Controller

Ziskej MVS trait

ZiskejMvsTrait::ziskejOrderAction() — Method in class ZiskejMvsTrait

Ziskej MVS order action

ZiskejMvsTrait::ziskejOrderPostAction() — Method in class ZiskejMvsTrait

Send Ziskej MVS order form

$ BuyLinksTrait#zboziServiceProperty in class BuyLinksTrait

Service for getting link to Zboží.cz

ZiskejBaseClass in namespace KnihovnyCz\RecordTab

Class ZiskejBase

$ ZiskejBase#ziskejApiProperty in class ZiskejBase
ZiskejEddClass in namespace KnihovnyCz\RecordTab

Record tab Ziskej Edd

ZiskejEddFactoryClass in namespace KnihovnyCz\RecordTab

Class ZiskejEddFactory

ZiskejMvsClass in namespace KnihovnyCz\RecordTab

Record tab Ziskej MVS

ZiskejMvsFactoryClass in namespace KnihovnyCz\RecordTab

Class ZiskejMvsFactory

$ JsonFacetListener#zeroCountFacetsProperty in class JsonFacetListener

Show all values for facets (ie. values with zero count)

ZboziLinkServiceClass in namespace KnihovnyCz\Service

Class ZboziService

ZiskejEddClass in namespace KnihovnyCz\View\Helper\KnihovnyCz

Ziskej Edd View Helper

ZiskejMvsClass in namespace KnihovnyCz\View\Helper\KnihovnyCz

Ziskej View Helper

ZiskejClass in namespace KnihovnyCz\Ziskej

KnihovnyCz Ziskej Class

ZiskejApiFactoryClass in namespace KnihovnyCz\Ziskej

Class ZiskejApiFactory

ZiskejEddClass in namespace KnihovnyCz\Ziskej

KnihovnyCz Ziskej Edd Class

ZiskejFactoryClass in namespace KnihovnyCz\Ziskej

Factory for instantiating objects

ZiskejMvsClass in namespace KnihovnyCz\Ziskej

KnihovnyCz Ziskej MVS Class

$ PubDateVisAjax#zoomingProperty in class PubDateVisAjax

Should we allow zooming? (String of "true" or "false")

_

SearchApiController::__construct() — Method in class SearchApiController
Constructor
SearchApiControllerFactory::__invoke() — Method in class SearchApiControllerFactory

Create an object

ClearCacheCommand::__construct() — Method in class ClearCacheCommand
Constructor
ClearCacheCommandFactory::__invoke() — Method in class ClearCacheCommandFactory

Create an object

ExpireCsrfTokensCommandFactory::__invoke() — Method in class ExpireCsrfTokensCommandFactory

Create an object

ExpireUsersCommandFactory::__invoke() — Method in class ExpireUsersCommandFactory

Create an object

UpdateResourcesFromSolrCommand::__construct() — Method in class UpdateResourcesFromSolrCommand
Constructor
UpdateResourcesFromSolrCommandFactory::__invoke() — Method in class UpdateResourcesFromSolrCommandFactory

Create an object

AbstractIlsAndUserActionFactory::__invoke() — Method in class AbstractIlsAndUserActionFactory

Create an object

Edd::__construct() — Method in class Edd

Edd constructor.

EddFactory::__invoke() — Method in class EddFactory

Create an object

GetACSuggestions::__construct() — Method in class GetACSuggestions
Constructor
GetACSuggestionsFactory::__invoke() — Method in class GetACSuggestionsFactory

Create an object

GetCitations::__construct() — Method in class GetCitations

Get citation ajax handler constructor.

GetCitationsFactory::__invoke() — Method in class GetCitationsFactory

Create an object

GetHolding::__construct() — Method in class GetHolding
Constructor
GetHoldingFactory::__invoke() — Method in class GetHoldingFactory

Create an object

GetLibrariesACSuggestions::__construct() — Method in class GetLibrariesACSuggestions
Constructor
GetLibrariesACSuggestionsFactory::__invoke() — Method in class GetLibrariesACSuggestionsFactory

Create an object

GetObalkyKnihCoverWithoutSolr::__construct() — Method in class GetObalkyKnihCoverWithoutSolr
Constructor
GetObalkyKnihCoverWithoutSolrFactory::__invoke() — Method in class GetObalkyKnihCoverWithoutSolrFactory

Create an object

GetUserFinesFactory::__invoke() — Method in class GetUserFinesFactory

Create an object

GetZiskejEddFee::__construct() — Method in class GetZiskejEddFee
Constructor
GetZiskejEddFeeFactory::__invoke() — Method in class GetZiskejEddFeeFactory

Create an object

HarvestWidgetsContents::__construct() — Method in class HarvestWidgetsContents
Constructor
HarvestWidgetsContentsFactory::__invoke() — Method in class HarvestWidgetsContentsFactory

Create an object

SaveInstitutionFilter::__construct() — Method in class SaveInstitutionFilter
Constructor
SaveInstitutionFilterFactory::__invoke() — Method in class SaveInstitutionFilterFactory

Create an object

Sfx::__construct() — Method in class Sfx
Constructor
SfxFactory::__invoke() — Method in class SfxFactory

Create an object

Manager::__construct() — Method in class Manager
Constructor
ManagerFactory::__invoke() — Method in class ManagerFactory

Create an object

Shibboleth::__construct() — Method in class Shibboleth
Constructor
Highlighter::__construct() — Method in class Highlighter
Constructor
SolrAuthorityEnricher::__construct() — Method in class SolrAuthorityEnricher
Constructor
SolrAuthorityEnricherFactory::__invoke() — Method in class SolrAuthorityEnricherFactory

Create an object

SolrFactoryWithFilter::__invoke() — Method in class SolrFactoryWithFilter

Create an object

SolrPrefix::__construct() — Method in class SolrPrefix
Constructor
SolrPrefixHandler::__construct() — Method in class SolrPrefixHandler
Constructor
SolrPrefixSorted::__construct() — Method in class SolrPrefixSorted
Constructor
Suggester::__construct() — Method in class Suggester
Constructor
SuggestionFilter::__construct() — Method in class SuggestionFilter
Constructor
SuggestionFilterFactory::__invoke() — Method in class SuggestionFilterFactory

Create an object

PluginFactory::__invoke() — Method in class PluginFactory

Create a service for the specified name.

PluginManager::__construct() — Method in class PluginManager
Constructor
PluginManagerFactory::__invoke() — Method in class PluginManagerFactory

Create an object

AbstractDbAwaredRecordIds::__construct() — Method in class AbstractDbAwaredRecordIds
Constructor
AbstractDbAwaredRecordIdsFactory::__invoke() — Method in class AbstractDbAwaredRecordIdsFactory

Create an object

DocumentTypes::__construct() — Method in class DocumentTypes

DocumentTypes constructor.

DocumentTypesFactory::__invoke() — Method in class DocumentTypesFactory

Create an object

TemplateBasedFactory::__invoke() — Method in class TemplateBasedFactory

Create an object

TemplateBasedForLoggedIn::__construct() — Method in class TemplateBasedForLoggedIn

TemplateBasedHiddenForLoggedIn constructor

TemplateBasedForLoggedInFactory::__invoke() — Method in class TemplateBasedForLoggedInFactory

Create an object

TemplateBasedForUnloggedIn::__construct() — Method in class TemplateBasedForUnloggedIn

TemplateBasedHiddenForLoggedIn constructor

TemplateBasedForUnloggedInFactory::__invoke() — Method in class TemplateBasedForUnloggedInFactory

Create an object

InvolvedLibrariesService::__construct() — Method in class InvolvedLibrariesService
Constructor
InvolvedLibrariesServiceFactory::__invoke() — Method in class InvolvedLibrariesServiceFactory

Create an object

ObalkyKnihService::__construct() — Method in class ObalkyKnihService
Constructor
PageLocator::__construct() — Method in class PageLocator

Page constructor.

PageLocatorFactory::__invoke() — Method in class PageLocatorFactory

Create an object

ObalkyKnih::__construct() — Method in class ObalkyKnih
Constructor
ContentControllerFactory::__invoke() — Method in class ContentControllerFactory

Create an object

MyResearchController::__construct() — Method in class MyResearchController
Constructor
ResultScroller::__construct() — Method in class ResultScroller

Constructor. Create a new search result scroller.

ResultScrollerFactory::__invoke() — Method in class ResultScrollerFactory

Create an object

RecordController::__construct() — Method in class RecordController
Constructor
SearchController::__construct() — Method in class SearchController
Constructor
Config::__construct() — Method in class Config
Constructor
CsrfToken::__construct() — Method in class CsrfToken
Constructor
InstConfigs::__construct() — Method in class InstConfigs
Constructor
InstSources::__construct() — Method in class InstSources
Constructor
UserListCategories::__construct() — Method in class UserListCategories
Constructor
UserListFactory::__invoke() — Method in class UserListFactory

Create an object

UserSettings::__construct() — Method in class UserSettings
Constructor
Config::__construct() — Method in class Config
Constructor
CsrfToken::__construct() — Method in class CsrfToken
Constructor
InstConfigs::__construct() — Method in class InstConfigs
Constructor
InstSources::__construct() — Method in class InstSources
Constructor
UserListCategories::__construct() — Method in class UserListCategories
Constructor
UserSettings::__construct() — Method in class UserSettings
Constructor
KohaRest1905::__construct() — Method in class KohaRest1905
Constructor
MultiBackend::__construct() — Method in class MultiBackend
Constructor
MultiBackendFactory::__invoke() — Method in class MultiBackendFactory

Create an object

MultiConnection::__construct() — Method in class MultiConnection
Constructor
MultiConnectionFactory::__invoke() — Method in class MultiConnectionFactory

Create an object

SolrIdResolver::__construct() — Method in class SolrIdResolver

SolrIdResolver constructor.

SolrIdResolverFactory::__invoke() — Method in class SolrIdResolverFactory

Create an object

InvolvedLibrariesBuilder::__construct() — Method in class InvolvedLibrariesBuilder
Contructor
InvolvedLibrariesExtension::__construct() — Method in class InvolvedLibrariesExtension
Constructor
InvolvedLibrariesExtensionFactory::__invoke() — Method in class InvolvedLibrariesExtensionFactory

Create an object

InvolvedLibrariesParser::__construct() — Method in class InvolvedLibrariesParser
Constructor
InvolvedLibrariesRenderer::__construct() — Method in class InvolvedLibrariesRenderer
Constructor
MapSelection::__construct() — Method in class MapSelection
Constructor
MapSelectionFactory::__invoke() — Method in class MapSelectionFactory

Create an object

RecommendOtherPortals::__construct() — Method in class RecommendOtherPortals
Constructor
SideFacetsDeferred::__construct() — Method in class SideFacetsDeferred
Constructor
SideFacetsDeferredFactory::__invoke() — Method in class SideFacetsDeferredFactory

Create an object

EdsFactory::__invoke() — Method in class EdsFactory

Create an object

SolrDefaultFactory::__invoke() — Method in class SolrDefaultFactory

Create an object

SolrLibrary::__construct() — Method in class SolrLibrary
Constructor
SolrLibraryFactory::__invoke() — Method in class SolrLibraryFactory

Create an object

SolrLocalFactory::__invoke() — Method in class SolrLocalFactory

Create an object

SummonFactory::__invoke() — Method in class SummonFactory

Create an object

ZiskejEdd::__construct() — Method in class ZiskejEdd
Constructor
ZiskejEddFactory::__invoke() — Method in class ZiskejEddFactory

Create an object

ZiskejMvs::__construct() — Method in class ZiskejMvs
Constructor
ZiskejMvsFactory::__invoke() — Method in class ZiskejMvsFactory

Create an object

Loader::__construct() — Method in class Loader
Constructor
LoaderFactory::__invoke() — Method in class LoaderFactory

Create an object

Search2BackendFactory::__construct() — Method in class Search2BackendFactory
Constructor
UrlQueryHelperFactory::__construct() — Method in class UrlQueryHelperFactory

UrlQueryHelperFactory constructor.

Options::__construct() — Method in class Options
Constructor
PerformanceLogger::__construct() — Method in class PerformanceLogger
Constructor
ChildDocDeduplicationListener::__construct() — Method in class ChildDocDeduplicationListener
Constructor.
DeduplicationListener::__construct() — Method in class DeduplicationListener
Constructor.
JsonFacetListener::__construct() — Method in class JsonFacetListener
Constructor.
MultiplyingDeduplicationListener::__construct() — Method in class MultiplyingDeduplicationListener
Constructor.
Params::__construct() — Method in class Params
Constructor
ParamsFactory::__invoke() — Method in class ParamsFactory

Create an object

Results::__construct() — Method in class Results
Constructor
CitaceProService::__construct() — Method in class CitaceProService

CitaceProService constructor.

CitaceProServiceFactory::__invoke() — Method in class CitaceProServiceFactory

Create an object

GuzzleHttpService::__construct() — Method in class GuzzleHttpService

GuzzleHttpService constructor.

GuzzleHttpServiceFactory::__invoke() — Method in class GuzzleHttpServiceFactory

Create an object

HttpService::__construct() — Method in class HttpService
Constructor.
HttpServiceFactory::__invoke() — Method in class HttpServiceFactory

Create an object

UserSettingsService::__construct() — Method in class UserSettingsService
Constructor.
UserSettingsServiceFactory::__invoke() — Method in class UserSettingsServiceFactory

Create an object

WayfFilterGenerator::__construct() — Method in class WayfFilterGenerator

WayfFilterGenerator constructor.

WayfFilterGeneratorFactory::__invoke() — Method in class WayfFilterGeneratorFactory

Create an object

NullSessionManager::__construct() — Method in class NullSessionManager
Constructor
Index::__construct() — Method in class Index
Constructor
IndexFactory::__invoke() — Method in class IndexFactory

Create an object

DatabaseCsrf::__construct() — Method in class DatabaseCsrf

DatabaseCsrf constructor

DatabaseCsrfFactory::__invoke() — Method in class DatabaseCsrfFactory

Create an object

ContextHelp::__invoke() — Method in class ContextHelp

Render context help

EscapeElementId::__invoke() — Method in class EscapeElementId

Escape identifier for use as selector in HTML

FooterLink::__invoke() — Method in class FooterLink
Invoke
GoogleTagManagerFactory::__invoke() — Method in class GoogleTagManagerFactory

Create an object

LibrariesApiLookfor::__invoke() — Method in class LibrariesApiLookfor

Create lookfor string, translate advanced search query into basic to be used as query string for search API

RecordDataFormatterFactory::__invoke() — Method in class RecordDataFormatterFactory

Create the helper.

RecordLinker::__construct() — Method in class RecordLinker
Constructor
RecordLinkerFactory::__invoke() — Method in class RecordLinkerFactory

Create an object

SearchTabs::__construct() — Method in class SearchTabs
Constructor
SearchTabsFactory::__invoke() — Method in class SearchTabsFactory

Create an object

SplitText::__invoke() — Method in class SplitText

Invoke function

TextFormatter::__invoke() — Method in class TextFormatter

Store a record driver object and return this object so that the appropriate template can be rendered.

UserCards::__invoke() — Method in class UserCards

Invoke function

ZiskejEdd::__construct() — Method in class ZiskejEdd
Constructor
ZiskejMvs::__construct() — Method in class ZiskejMvs
Constructor
SparqlService::__construct() — Method in class SparqlService
Constructor
SparqlServiceFactory::__invoke() — Method in class SparqlServiceFactory

Create an object

Ziskej::__construct() — Method in class Ziskej
Constructor
ZiskejApiFactory::__invoke() — Method in class ZiskejApiFactory

Create Ziskej Api service

ZiskejFactory::__invoke() — Method in class ZiskejFactory

Create service

AbstractAdmin::__construct() — Method in class AbstractAdmin
Constructor
AdminApiController::__construct() — Method in class AdminApiController
Constructor
AdminApiControllerFactory::__invoke() — Method in class AdminApiControllerFactory

Create an object

ApiControllerFactory::__invoke() — Method in class ApiControllerFactory

Create an object

Search2ApiControllerFactory::__invoke() — Method in class Search2ApiControllerFactory

Create an object

SearchApiController::__construct() — Method in class SearchApiController
Constructor
SearchApiControllerFactory::__invoke() — Method in class SearchApiControllerFactory

Create an object

WebApiControllerFactory::__invoke() — Method in class WebApiControllerFactory

Create an object

RecordFormatter::__construct() — Method in class RecordFormatter
Constructor
RecordFormatterFactory::__invoke() — Method in class RecordFormatterFactory

Create an object

ThemeCommand::__construct() — Method in class ThemeCommand
Constructor
ThemeCommandFactory::__invoke() — Method in class ThemeCommandFactory

Create an object

AbstractCommand::__construct() — Method in class AbstractCommand
Constructor
AbstractCommandFactory::__invoke() — Method in class AbstractCommandFactory

Create an object

AbstractContainerAwareCommand::__construct() — Method in class AbstractContainerAwareCommand
Constructor
AbstractContainerAwareCommandFactory::__invoke() — Method in class AbstractContainerAwareCommandFactory

Create an object

AbstractRouteCommand::__construct() — Method in class AbstractRouteCommand
Constructor
AbstractRouteCommandFactory::__invoke() — Method in class AbstractRouteCommandFactory

Create an object

AbstractThemeCommand::__construct() — Method in class AbstractThemeCommand
Constructor
NonTabRecordActionCommand::__construct() — Method in class NonTabRecordActionCommand
Constructor
NonTabRecordActionCommandFactory::__invoke() — Method in class NonTabRecordActionCommandFactory

Create an object

ThemeCommand::__construct() — Method in class ThemeCommand
Constructor
ThemeCommandFactory::__invoke() — Method in class ThemeCommandFactory

Create an object

ThemeMixinCommandFactory::__invoke() — Method in class ThemeMixinCommandFactory

Create an object

HarvestOaiCommand::__construct() — Method in class HarvestOaiCommand
Constructor
HarvestOaiCommandFactory::__invoke() — Method in class HarvestOaiCommandFactory

Create an object

ImportCsvCommand::__construct() — Method in class ImportCsvCommand
Constructor
ImportCsvCommandFactory::__invoke() — Method in class ImportCsvCommandFactory

Create an object

ImportXslCommand::__construct() — Method in class ImportXslCommand
Constructor
ImportXslCommandFactory::__invoke() — Method in class ImportXslCommandFactory

Create an object

WebCrawlCommand::__construct() — Method in class WebCrawlCommand
Constructor
WebCrawlCommandFactory::__invoke() — Method in class WebCrawlCommandFactory

Create an object

InstallCommand::__construct() — Method in class InstallCommand
Constructor
AbstractCommand::__construct() — Method in class AbstractCommand
Constructor
AbstractCommandFactory::__invoke() — Method in class AbstractCommandFactory

Create an object

PluginManager::__construct() — Method in class PluginManager
Constructor
NotifyCommand::__construct() — Method in class NotifyCommand
Constructor
NotifyCommandFactory::__invoke() — Method in class NotifyCommandFactory

Create an object

AbstractCssBuilderCommand::__construct() — Method in class AbstractCssBuilderCommand
Constructor
AbstractExpireCommand::__construct() — Method in class AbstractExpireCommand
Constructor
AbstractSolrAndIlsCommand::__construct() — Method in class AbstractSolrAndIlsCommand
Constructor
AbstractSolrAndIlsCommandFactory::__invoke() — Method in class AbstractSolrAndIlsCommandFactory

Create an object

AbstractSolrCommand::__construct() — Method in class AbstractSolrCommand
Constructor
AbstractSolrCommandFactory::__invoke() — Method in class AbstractSolrCommandFactory

Create an object

CleanUpRecordCacheCommand::__construct() — Method in class CleanUpRecordCacheCommand
Constructor
CleanUpRecordCacheCommandFactory::__invoke() — Method in class CleanUpRecordCacheCommandFactory

Create an object

CreateHierarchyTreesCommand::__construct() — Method in class CreateHierarchyTreesCommand
Constructor
CreateHierarchyTreesCommandFactory::__invoke() — Method in class CreateHierarchyTreesCommandFactory

Create an object

ExpireAccessTokensCommandFactory::__invoke() — Method in class ExpireAccessTokensCommandFactory

Create an object

ExpireAuthHashesCommandFactory::__invoke() — Method in class ExpireAuthHashesCommandFactory

Create an object

ExpireExternalSessionsCommandFactory::__invoke() — Method in class ExpireExternalSessionsCommandFactory

Create an object

ExpireSearchesCommandFactory::__invoke() — Method in class ExpireSearchesCommandFactory

Create an object

ExpireSessionsCommandFactory::__invoke() — Method in class ExpireSessionsCommandFactory

Create an object

ScssBuilderCommandFactory::__invoke() — Method in class ScssBuilderCommandFactory

Create an object

SitemapCommand::__construct() — Method in class SitemapCommand
Constructor
SitemapCommandFactory::__invoke() — Method in class SitemapCommandFactory

Create an object

SwitchDbHashCommand::__construct() — Method in class SwitchDbHashCommand
Constructor
SwitchDbHashCommandFactory::__invoke() — Method in class SwitchDbHashCommandFactory

Create an object

ConsoleRunner::__construct() — Method in class ConsoleRunner
Constructor
ConsoleRunnerFactory::__invoke() — Method in class ConsoleRunnerFactory

Create an object

GeneratorTools::__construct() — Method in class GeneratorTools
Constructor.
GeneratorToolsFactory::__invoke() — Method in class GeneratorToolsFactory

Create an object

LanguageHelper::__construct() — Method in class LanguageHelper
Constructor
Backend::__construct() — Method in class Backend
Constructor.
RecordCollection::__construct() — Method in class RecordCollection
Constructor
Backend::__construct() — Method in class Backend
Constructor.
LookupDoiCommand::__construct() — Method in class LookupDoiCommand
Constructor
LookupIssnsCommand::__construct() — Method in class LookupIssnsCommand
Constructor
Connector::__construct() — Method in class Connector
Constructor
RecordCollection::__construct() — Method in class RecordCollection
Constructor.
RecordCollectionFactory::__construct() — Method in class RecordCollectionFactory
Constructor.
ApiException::__construct() — Method in class ApiException
Constructor
Backend::__construct() — Method in class Backend
Constructor.
Base::__construct() — Method in class Base
Constructor
AutocompleteCommand::__construct() — Method in class AutocompleteCommand
Constructor.
GetInfoCommand::__construct() — Method in class GetInfoCommand
Constructor.
Connector::__construct() — Method in class Connector
Constructor
QueryBuilder::__construct() — Method in class QueryBuilder
Constructor
RecordCollection::__construct() — Method in class RecordCollection
Constructor.
RecordCollectionFactory::__construct() — Method in class RecordCollectionFactory
Constructor.
SearchRequestModel::__construct() — Method in class SearchRequestModel
Constructor
SearchRequestModel::__get() — Method in class SearchRequestModel

Magic getter

SearchRequestModel::__set() — Method in class SearchRequestModel

Magic setter

Backend::__construct() — Method in class Backend
Constructor.
Connector::__construct() — Method in class Connector
Constructor
QueryBuilder::__construct() — Method in class QueryBuilder
Constructor
RecordCollection::__construct() — Method in class RecordCollection
Constructor.
RecordCollectionFactory::__construct() — Method in class RecordCollectionFactory
Constructor.
DeepPagingException::__construct() — Method in class DeepPagingException
Constructor.
HttpErrorException::__construct() — Method in class HttpErrorException
Constructor.
Backend::__construct() — Method in class Backend
Constructor.
Connector::__construct() — Method in class Connector
Constructor
RecordCollection::__construct() — Method in class RecordCollection
Constructor.
RecordCollectionFactory::__construct() — Method in class RecordCollectionFactory
Constructor.
Backend::__construct() — Method in class Backend
Constructor.
Connector::__construct() — Method in class Connector
Constructor
QueryBuilder::__construct() — Method in class QueryBuilder
Constructor
Record::__construct() — Method in class Record
Constructor.
RecordCollection::__construct() — Method in class RecordCollection
Constructor.
RecordCollectionFactory::__construct() — Method in class RecordCollectionFactory
Constructor.
Backend::__construct() — Method in class Backend
Constructor.
Connector::__construct() — Method in class Connector
Constructor
RecordCollection::__construct() — Method in class RecordCollection
Constructor.
RecordCollectionFactory::__construct() — Method in class RecordCollectionFactory
Constructor.
Connector::__construct() — Method in class Connector
Constructor
Backend::__construct() — Method in class Backend
Constructor.
RawJsonSearchCommand::__construct() — Method in class RawJsonSearchCommand
Constructor
WriteDocumentCommand::__construct() — Method in class WriteDocumentCommand
Constructor.
Connector::__construct() — Method in class Connector
Constructor
CommitDocument::__construct() — Method in class CommitDocument
Constructor.
OptimizeDocument::__construct() — Method in class OptimizeDocument
Constructor.
RawCSVDocument::__construct() — Method in class RawCSVDocument
Constructor.
RawDocument::__construct() — Method in class RawDocument
Constructor.
RawJSONDocument::__construct() — Method in class RawJSONDocument
Constructor.
RawXMLDocument::__construct() — Method in class RawXMLDocument
Constructor.
UpdateDocument::__construct() — Method in class UpdateDocument
Constructor.
HandlerMap::__construct() — Method in class HandlerMap
Constructor.
LuceneSyntaxHelper::__construct() — Method in class LuceneSyntaxHelper
Constructor.
QueryBuilder::__construct() — Method in class QueryBuilder
Constructor.
SerializableRecord::__construct() — Method in class SerializableRecord
Constructor
NamedList::__construct() — Method in class NamedList
Constructor.
Record::__construct() — Method in class Record
Constructor.
Record::__get() — Method in class Record
__get()
RecordCollection::__construct() — Method in class RecordCollection
Constructor.
RecordCollectionFactory::__construct() — Method in class RecordCollectionFactory
Constructor.
Spellcheck::__construct() — Method in class Spellcheck
Constructor.
Terms::__construct() — Method in class Terms
Constructor.
SearchHandler::__construct() — Method in class SearchHandler
Constructor.
SimilarBuilder::__construct() — Method in class SimilarBuilder
Constructor.
Backend::__construct() — Method in class Backend
Constructor.
RecordCollection::__construct() — Method in class RecordCollection
Constructor.
RecordCollectionFactory::__construct() — Method in class RecordCollectionFactory
Constructor.
Backend::__construct() — Method in class Backend
Constructor.
GetHoldingsCommand::__construct() — Method in class GetHoldingsCommand
Constructor
Connector::__construct() — Method in class Connector
Constructor
QueryBuilder::__construct() — Method in class QueryBuilder
Constructor
Record::__construct() — Method in class Record
Constructor.
RecordCollection::__construct() — Method in class RecordCollection
Constructor.
RecordCollectionFactory::__construct() — Method in class RecordCollectionFactory
Constructor.
AbstractBase::__construct() — Method in class AbstractBase
Constructor.
AlphabeticBrowseCommand::__construct() — Method in class AlphabeticBrowseCommand
Constructor.
CallMethodCommand::__construct() — Method in class CallMethodCommand

CallMethodCommand constructor.

GetIdsCommand::__construct() — Method in class GetIdsCommand

GetIdsCommand constructor.

GetLuceneHelperCommand::__construct() — Method in class GetLuceneHelperCommand
Constructor.
GetQueryBuilderCommand::__construct() — Method in class GetQueryBuilderCommand
Constructor.
RandomCommand::__construct() — Method in class RandomCommand

RandomCommand constructor.

RetrieveBatchCommand::__construct() — Method in class RetrieveBatchCommand

RetrieveBatchCommand constructor.

RetrieveCommand::__construct() — Method in class RetrieveCommand

RetrieveCommand constructor.

SearchCommand::__construct() — Method in class SearchCommand

SearchCommand constructor.

SetRecordCollectionFactoryCommand::__construct() — Method in class SetRecordCollectionFactoryCommand
Constructor.
SimilarCommand::__construct() — Method in class SimilarCommand

SimilarCommand constructor.

TermsCommand::__construct() — Method in class TermsCommand
Constructor.
WorkExpressionsCommand::__construct() — Method in class WorkExpressionsCommand

WorkExpressionsCommand constructor.

ParamBag::__construct() — Method in class ParamBag
Constructor.
Query::__construct() — Method in class Query
Constructor.
QueryGroup::__construct() — Method in class QueryGroup
Constructor.
QueryGroup::__clone() — Method in class QueryGroup

Copy constructor

SimpleRecord::__construct() — Method in class SimpleRecord
Constructor
Service::__construct() — Method in class Service
Constructor.
ImageFactoryTest::__construct() — Method in class ImageFactoryTest
Constructor
MockContainerTrait::__construct() — Method in class MockContainerTrait
Constructor
ResultScrollerMock::__construct() — Method in class ResultScrollerMock

Constructor. Create a new search result scroller.

UserIpReader::__construct() — Method in class UserIpReader
Constructor
TestHarness::__construct() — Method in class TestHarness
Constructor
TestHarness::__call() — Method in class TestHarness

Magic method to set/retrieve fields.

Options::__construct() — Method in class Options
Constructor
Results::__construct() — Method in class Results
Constructor
StartPageTest::__invoke() — Method in class StartPageTest

Receive a message

AbstractCssPreCompiler::__construct() — Method in class AbstractCssPreCompiler
Constructor
AbstractThemeUtility::__construct() — Method in class AbstractThemeUtility
Constructor
Initializer::__construct() — Method in class Initializer
Constructor
InjectTemplateListener::__construct() — Method in class InjectTemplateListener

InjectTemplateListener constructor.

InjectTemplateListenerFactory::__invoke() — Method in class InjectTemplateListenerFactory

Create an object

Mobile::__construct() — Method in class Mobile
Constructor
ThemeGenerator::__construct() — Method in class ThemeGenerator
Constructor
ThemeGeneratorFactory::__invoke() — Method in class ThemeGeneratorFactory

Create an object

ThemeInfo::__construct() — Method in class ThemeInfo
Constructor
ThemeInfoFactory::__invoke() — Method in class ThemeInfoFactory

Create an object

ThemeInfoInjectorFactory::__invoke() — Method in class ThemeInfoInjectorFactory

Create an object

HeadLink::__construct() — Method in class HeadLink
Constructor
HeadScript::__construct() — Method in class HeadScript
Constructor
ImageLink::__construct() — Method in class ImageLink
Constructor
ImageLink::__invoke() — Method in class ImageLink

Returns an image path according the configured theme

ImageLinkFactory::__invoke() — Method in class ImageLinkFactory

Create an object

InlineScript::__invoke() — Method in class InlineScript

Return InlineScript object

ParentTemplate::__construct() — Method in class ParentTemplate
Constructor
ParentTemplate::__invoke() — Method in class ParentTemplate

Returns an template path according the configured theme

ParentTemplateFactory::__invoke() — Method in class ParentTemplateFactory

Create an object

PipelineInjectorFactory::__invoke() — Method in class PipelineInjectorFactory

Create an object

SetupThemeResources::__construct() — Method in class SetupThemeResources
Constructor
SetupThemeResources::__invoke() — Method in class SetupThemeResources

Set up items based on contents of theme resource container.

SetupThemeResourcesFactory::__invoke() — Method in class SetupThemeResourcesFactory

Create an object

Slot::__invoke() — Method in class Slot

Get the Slot instance. Create if instance doesn't exist.

Slot::__toString() — Method in class Slot

Shortcut to get if no methods are called on invoke.

TemplatePath::__construct() — Method in class TemplatePath
Constructor
TemplatePath::__invoke() — Method in class TemplatePath

Returns an template path according the configured theme

TemplatePathFactory::__invoke() — Method in class TemplatePathFactory

Create an object

AbstractIlsAndUserAction::__construct() — Method in class AbstractIlsAndUserAction
Constructor
AbstractIlsAndUserActionFactory::__invoke() — Method in class AbstractIlsAndUserActionFactory

Create an object

AbstractRelaisAction::__construct() — Method in class AbstractRelaisAction
Constructor
AbstractRelaisActionFactory::__invoke() — Method in class AbstractRelaisActionFactory

Create an object

CommentRecord::__construct() — Method in class CommentRecord
Constructor
CommentRecordFactory::__invoke() — Method in class CommentRecordFactory

Create an object

DeleteRecordComment::__construct() — Method in class DeleteRecordComment
Constructor
DeleteRecordCommentFactory::__invoke() — Method in class DeleteRecordCommentFactory

Create an object

DoiLookup::__construct() — Method in class DoiLookup
Constructor
DoiLookupFactory::__invoke() — Method in class DoiLookupFactory

Create an object

GetACSuggestions::__construct() — Method in class GetACSuggestions
Constructor
GetACSuggestionsFactory::__invoke() — Method in class GetACSuggestionsFactory

Create an object

GetFacetData::__construct() — Method in class GetFacetData
Constructor
GetFacetDataFactory::__invoke() — Method in class GetFacetDataFactory

Create an object

GetIlsStatus::__construct() — Method in class GetIlsStatus
Constructor
GetIlsStatusFactory::__invoke() — Method in class GetIlsStatusFactory

Create an object

GetItemStatuses::__construct() — Method in class GetItemStatuses
Constructor
GetItemStatusesFactory::__invoke() — Method in class GetItemStatusesFactory

Create an object

GetRecordCommentsAsHTML::__construct() — Method in class GetRecordCommentsAsHTML
Constructor
GetRecordCommentsAsHTMLFactory::__invoke() — Method in class GetRecordCommentsAsHTMLFactory

Create an object

GetRecordCover::__construct() — Method in class GetRecordCover

GetRecordCover constructor.

GetRecordCoverFactory::__invoke() — Method in class GetRecordCoverFactory

Create an object

GetRecordDetails::__construct() — Method in class GetRecordDetails
Constructor
GetRecordDetailsFactory::__invoke() — Method in class GetRecordDetailsFactory

Create an object

GetRecordRating::__construct() — Method in class GetRecordRating
Constructor
GetRecordRatingFactory::__invoke() — Method in class GetRecordRatingFactory

Create an object

GetRecordTags::__construct() — Method in class GetRecordTags
Constructor
GetRecordTagsFactory::__invoke() — Method in class GetRecordTagsFactory

Create an object

GetRecordVersions::__construct() — Method in class GetRecordVersions
Constructor
GetRecordVersionsFactory::__invoke() — Method in class GetRecordVersionsFactory

Create an object

GetResolverLinks::__construct() — Method in class GetResolverLinks
Constructor
GetResolverLinksFactory::__invoke() — Method in class GetResolverLinksFactory

Create an object

GetResultCount::__construct() — Method in class GetResultCount
Constructor
GetResultCountFactory::__invoke() — Method in class GetResultCountFactory

Create an object

GetSaveStatuses::__construct() — Method in class GetSaveStatuses
Constructor
GetSaveStatusesFactory::__invoke() — Method in class GetSaveStatusesFactory

Create an object

GetSideFacets::__construct() — Method in class GetSideFacets
Constructor
GetSideFacetsFactory::__invoke() — Method in class GetSideFacetsFactory

Create an object

GetUserFines::__construct() — Method in class GetUserFines
Constructor
GetUserFinesFactory::__invoke() — Method in class GetUserFinesFactory

Create an object

GetVisData::__construct() — Method in class GetVisData
Constructor
GetVisDataFactory::__invoke() — Method in class GetVisDataFactory

Create an object

KeepAlive::__construct() — Method in class KeepAlive
Constructor
KeepAliveFactory::__invoke() — Method in class KeepAliveFactory

Create an object

Recommend::__construct() — Method in class Recommend
Constructor
RecommendFactory::__invoke() — Method in class RecommendFactory

Create an object

SystemStatus::__construct() — Method in class SystemStatus
Constructor
SystemStatusFactory::__invoke() — Method in class SystemStatusFactory

Create an object

TagRecord::__construct() — Method in class TagRecord
Constructor
TagRecordFactory::__invoke() — Method in class TagRecordFactory

Create an object

AlmaDatabase::__construct() — Method in class AlmaDatabase
Constructor
AuthToken::__construct() — Method in class AuthToken

AuthToken constructor.

AuthToken::__toString() — Method in class AuthToken

To string casting method

ChoiceAuth::__construct() — Method in class ChoiceAuth
Constructor
ChoiceAuthFactory::__invoke() — Method in class ChoiceAuthFactory

Create an object

Email::__construct() — Method in class Email
Constructor
EmailAuthenticator::__construct() — Method in class EmailAuthenticator
Constructor
EmailAuthenticatorFactory::__invoke() — Method in class EmailAuthenticatorFactory

Create an object

EmailFactory::__invoke() — Method in class EmailFactory

Create an object

Facebook::__construct() — Method in class Facebook
Constructor
FacebookFactory::__invoke() — Method in class FacebookFactory

Create an object

ILS::__construct() — Method in class ILS
Constructor
ILSAuthenticator::__construct() — Method in class ILSAuthenticator
Constructor
ILSAuthenticatorFactory::__invoke() — Method in class ILSAuthenticatorFactory

Create an object

ILSFactory::__invoke() — Method in class ILSFactory

Create an object

Manager::__construct() — Method in class Manager
Constructor
ManagerFactory::__invoke() — Method in class ManagerFactory

Create an object

MultiAuthFactory::__invoke() — Method in class MultiAuthFactory

Create an object

PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginManager::__construct() — Method in class PluginManager
Constructor
Shibboleth::__construct() — Method in class Shibboleth
Constructor
ShibbolethFactory::__invoke() — Method in class ShibbolethFactory

Create an object

MultiIdPConfigurationLoader::__construct() — Method in class MultiIdPConfigurationLoader
Constructor
SingleIdPConfigurationLoader::__construct() — Method in class SingleIdPConfigurationLoader
Constructor
Eds::__construct() — Method in class Eds
Constructor
EdsFactory::__invoke() — Method in class EdsFactory

Create an object

PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginManager::__construct() — Method in class PluginManager
Constructor
Solr::__construct() — Method in class Solr
Constructor
SolrAuth::__construct() — Method in class SolrAuth
Constructor
SolrFactory::__invoke() — Method in class SolrFactory

Create an object

SolrPrefix::__construct() — Method in class SolrPrefix
Constructor
SolrReserves::__construct() — Method in class SolrReserves
Constructor
Suggester::__construct() — Method in class Suggester
Constructor
SuggesterFactory::__invoke() — Method in class SuggesterFactory

Create an object

Bootstrapper::__construct() — Method in class Bootstrapper
Constructor
Importer::__construct() — Method in class Importer
Constructor
ImporterConfig::__construct() — Method in class ImporterConfig
Constructor
Manager::__construct() — Method in class Manager
Constructor
ManagerFactory::__invoke() — Method in class ManagerFactory

Create an object

FigletFactory::__invoke() — Method in class FigletFactory

Create an object

Image::__construct() — Method in class Image
Constructor
ImageFactory::__invoke() — Method in class ImageFactory

Create an object

Interval::__construct() — Method in class Interval
Constructor
IntervalFactory::__invoke() — Method in class IntervalFactory

Create an object

LaminasBase::__construct() — Method in class LaminasBase
Constructor
ReCaptcha::__construct() — Method in class ReCaptcha
Constructor
ReCaptchaFactory::__invoke() — Method in class ReCaptchaFactory

Create an object

Cart::__construct() — Method in class Cart
Constructor
CartFactory::__invoke() — Method in class CartFactory

Create an object

AbstractILSChannelProvider::__construct() — Method in class AbstractILSChannelProvider
Constructor
AbstractILSChannelProviderFactory::__invoke() — Method in class AbstractILSChannelProviderFactory

Create an object

AlphaBrowse::__construct() — Method in class AlphaBrowse
Constructor
AlphaBrowseFactory::__invoke() — Method in class AlphaBrowseFactory

Create an object

ChannelLoader::__construct() — Method in class ChannelLoader
Constructor
ChannelLoaderFactory::__invoke() — Method in class ChannelLoaderFactory

Create an object

Facets::__construct() — Method in class Facets
Constructor
FacetsFactory::__invoke() — Method in class FacetsFactory

Create an object

ListItems::__construct() — Method in class ListItems
Constructor
ListItemsFactory::__invoke() — Method in class ListItemsFactory

Create an object

PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginManager::__construct() — Method in class PluginManager
Constructor
Random::__construct() — Method in class Random
Constructor
RandomFactory::__invoke() — Method in class RandomFactory

Create an object

RouterInitializer::__invoke() — Method in class RouterInitializer

Given an instance and a Service Manager, initialize the instance.

SimilarItems::__construct() — Method in class SimilarItems
Constructor
SimilarItemsFactory::__invoke() — Method in class SimilarItemsFactory

Create an object

AccountCapabilities::__construct() — Method in class AccountCapabilities
Constructor
AccountCapabilitiesFactory::__invoke() — Method in class AccountCapabilitiesFactory

Create an object

PathResolver::__construct() — Method in class PathResolver
Constructor
PathResolverFactory::__invoke() — Method in class PathResolverFactory

Create an object

PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginFactory::__invoke() — Method in class PluginFactory

Create a service for the specified name.

PluginManager::__construct() — Method in class PluginManager
Constructor
PluginManagerFactory::__invoke() — Method in class PluginManagerFactory

Create an object

CacheDecorator::__construct() — Method in class CacheDecorator
Constructor.
SearchSpecsReader::__construct() — Method in class SearchSpecsReader
Constructor
Upgrade::__construct() — Method in class Upgrade
Constructor
Writer::__construct() — Method in class Writer
Constructor
YamlReader::__construct() — Method in class YamlReader
Constructor
YamlReaderFactory::__invoke() — Method in class YamlReaderFactory

Create an object

OpenLibrary::__construct() — Method in class OpenLibrary
Constructor
Oracle::__construct() — Method in class Oracle

Constructor -- connect to database.

Oracle::__destruct() — Method in class Oracle
Destructor
Relais::__construct() — Method in class Relais
Constructor
RelaisFactory::__invoke() — Method in class RelaisFactory

Create an object

Wikipedia::__construct() — Method in class Wikipedia
Constructor
WorldCatUtils::__construct() — Method in class WorldCatUtils
Constructor
WorldCatUtilsFactory::__invoke() — Method in class WorldCatUtilsFactory

Create an object

BlockLoader::__construct() — Method in class BlockLoader
Constructor
BlockLoaderFactory::__invoke() — Method in class BlockLoaderFactory

Create an object

Channels::__construct() — Method in class Channels
Constructor
ChannelsFactory::__invoke() — Method in class ChannelsFactory

Create an object

FacetList::__construct() — Method in class FacetList
Constructor
FacetListFactory::__invoke() — Method in class FacetListFactory

Create an object

PluginManager::__construct() — Method in class PluginManager
Constructor
TemplateBased::__construct() — Method in class TemplateBased

TemplateBased constructor.

TemplateBasedFactory::__invoke() — Method in class TemplateBasedFactory

Create an object

AbstractSyndetics::__construct() — Method in class AbstractSyndetics
Constructor
AbstractSyndeticsFactory::__invoke() — Method in class AbstractSyndeticsFactory

Create an object

Bokinfo::__construct() — Method in class Bokinfo
Constructor
Booksite::__construct() — Method in class Booksite
Constructor
BooksiteFactory::__invoke() — Method in class BooksiteFactory

Create an object

BrowZine::__construct() — Method in class BrowZine
Constructor
BrowZineFactory::__invoke() — Method in class BrowZineFactory

Create an object

Buchhandel::__construct() — Method in class Buchhandel
Constructor
BuchhandelFactory::__invoke() — Method in class BuchhandelFactory

Create an object

ContentCafe::__construct() — Method in class ContentCafe
Constructor
ContentCafeFactory::__invoke() — Method in class ContentCafeFactory

Create an object

Google::__construct() — Method in class Google
Constructor
LibraryThing::__construct() — Method in class LibraryThing
Constructor
ObalkyKnih::__construct() — Method in class ObalkyKnih
Constructor
OpenLibrary::__construct() — Method in class OpenLibrary
Constructor
Orb::__construct() — Method in class Orb
Constructor
OrbFactory::__invoke() — Method in class OrbFactory

Create an object

Summon::__construct() — Method in class Summon
Constructor
Syndetics::__construct() — Method in class Syndetics
Constructor
SyndeticsFactory::__invoke() — Method in class SyndeticsFactory

Create an object

Factory::__invoke() — Method in class Factory

Create an object

Loader::__construct() — Method in class Loader
Constructor
ObalkyKnihContentFactory::__invoke() — Method in class ObalkyKnihContentFactory

Create an object

ObalkyKnihService::__construct() — Method in class ObalkyKnihService
Constructor
ObalkyKnihServiceFactory::__invoke() — Method in class ObalkyKnihServiceFactory

Create an object

PageLocator::__construct() — Method in class PageLocator

Page constructor.

PageLocatorFactory::__invoke() — Method in class PageLocatorFactory

Create an object

Booksite::__construct() — Method in class Booksite
Constructor
BooksiteFactory::__invoke() — Method in class BooksiteFactory

Create an object

AbstractBase::__construct() — Method in class AbstractBase
Constructor
AbstractBaseFactory::__invoke() — Method in class AbstractBaseFactory

Create an object

AbstractBaseWithConfigFactory::__invoke() — Method in class AbstractBaseWithConfigFactory

Create an object

AjaxController::__construct() — Method in class AjaxController
Constructor
AjaxControllerFactory::__invoke() — Method in class AjaxControllerFactory

Create an object

AlmaController::__construct() — Method in class AlmaController

Alma Controller constructor.

AuthorityController::__construct() — Method in class AuthorityController
Constructor
AuthorityRecordController::__construct() — Method in class AuthorityRecordController
Constructor
BrowZineController::__construct() — Method in class BrowZineController
Constructor
BrowseController::__construct() — Method in class BrowseController
Constructor
CartController::__construct() — Method in class CartController
Constructor
CartControllerFactory::__invoke() — Method in class CartControllerFactory

Create an object

ChannelsController::__construct() — Method in class ChannelsController
Constructor
ChannelsControllerFactory::__invoke() — Method in class ChannelsControllerFactory

Create an object

CollectionController::__construct() — Method in class CollectionController
Constructor
CollectionsController::__construct() — Method in class CollectionsController
Constructor
CombinedController::__construct() — Method in class CombinedController
Constructor
CoverController::__construct() — Method in class CoverController
Constructor
CoverControllerFactory::__invoke() — Method in class CoverControllerFactory

Create an object

EITController::__construct() — Method in class EITController
Constructor
EITrecordController::__construct() — Method in class EITrecordController
Constructor
EdsController::__construct() — Method in class EdsController
Constructor
EdsrecordController::__construct() — Method in class EdsrecordController
Constructor
HoldsController::__construct() — Method in class HoldsController
Constructor
HoldsControllerFactory::__invoke() — Method in class HoldsControllerFactory

Create an object

IndexController::__construct() — Method in class IndexController
Constructor
IndexControllerFactory::__invoke() — Method in class IndexControllerFactory

Create an object

LibGuidesController::__construct() — Method in class LibGuidesController
Constructor
OAuth2Controller::__construct() — Method in class OAuth2Controller
Constructor
OAuth2ControllerFactory::__invoke() — Method in class OAuth2ControllerFactory

Create an object

OverdriveController::__construct() — Method in class OverdriveController
Constructor
Pazpar2Controller::__construct() — Method in class Pazpar2Controller
Constructor
Pazpar2recordController::__construct() — Method in class Pazpar2recordController
Constructor
AbstractRequestBase::__construct() — Method in class AbstractRequestBase
Constructor
AbstractRequestBaseFactory::__invoke() — Method in class AbstractRequestBaseFactory

Create an object

Captcha::__construct() — Method in class Captcha
Constructor
CaptchaFactory::__invoke() — Method in class CaptchaFactory

Create an object

Favorites::__construct() — Method in class Favorites
Constructor
FavoritesFactory::__invoke() — Method in class FavoritesFactory

Create an object

FlashMessengerFactory::__invoke() — Method in class FlashMessengerFactory

Create an object

Followup::__construct() — Method in class Followup
Constructor
FollowupFactory::__invoke() — Method in class FollowupFactory

Create an object

IlsRecords::__construct() — Method in class IlsRecords
Constructor
IlsRecordsFactory::__invoke() — Method in class IlsRecordsFactory

Create an object

NewItems::__construct() — Method in class NewItems
Constructor
NewItemsFactory::__invoke() — Method in class NewItemsFactory

Create an object

Permission::__construct() — Method in class Permission
Constructor
PermissionFactory::__invoke() — Method in class PermissionFactory

Create an object

Reserves::__construct() — Method in class Reserves
Constructor
ReservesFactory::__invoke() — Method in class ReservesFactory

Create an object

ResultScroller::__construct() — Method in class ResultScroller

Constructor. Create a new search result scroller.

ResultScrollerFactory::__invoke() — Method in class ResultScrollerFactory

Create an object

PrimoController::__construct() — Method in class PrimoController
Constructor
PrimorecordController::__construct() — Method in class PrimorecordController
Constructor
QRCodeController::__construct() — Method in class QRCodeController
Constructor
QRCodeControllerFactory::__invoke() — Method in class QRCodeControllerFactory

Create an object

RecordController::__construct() — Method in class RecordController
Constructor
RecordsController::__construct() — Method in class RecordsController
Constructor
Search2Controller::__construct() — Method in class Search2Controller
Constructor
Search2recordController::__construct() — Method in class Search2recordController
Constructor
ShibbolethLogoutNotificationController::__construct() — Method in class ShibbolethLogoutNotificationController
Constructor
ShortlinkController::__construct() — Method in class ShortlinkController
Constructor
SummonController::__construct() — Method in class SummonController
Constructor
SummonrecordController::__construct() — Method in class SummonrecordController
Constructor
TagController::__construct() — Method in class TagController
Constructor
UpgradeController::__construct() — Method in class UpgradeController
Constructor
UpgradeControllerFactory::__invoke() — Method in class UpgradeControllerFactory

Create an object

WebController::__construct() — Method in class WebController
Constructor
WorldcatController::__construct() — Method in class WorldcatController
Constructor
WorldcatrecordController::__construct() — Method in class WorldcatrecordController
Constructor
Container::__construct() — Method in class Container
Constructor
Container::__get() — Method in class Container

Get the value of a variable in this object.

Container::__set() — Method in class Container

Set a variable in this object.

Container::__isset() — Method in class Container

Test the existence of a variable in this object.

Container::__unset() — Method in class Container

Unset a variable in this object.

CookieManager::__construct() — Method in class CookieManager
Constructor
CookieManagerFactory::__invoke() — Method in class CookieManagerFactory

Create an object

CachingProxy::__construct() — Method in class CachingProxy
Constructor
CachingProxyFactory::__invoke() — Method in class CachingProxyFactory

Create an object

Generator::__construct() — Method in class Generator
Constructor
GeneratorFactory::__invoke() — Method in class GeneratorFactory

Create an object

Loader::__construct() — Method in class Loader
Constructor
LoaderFactory::__invoke() — Method in class LoaderFactory

Create an object

Router::__construct() — Method in class Router
Constructor
RouterFactory::__invoke() — Method in class RouterFactory

Create an object

HMAC::__construct() — Method in class HMAC
Constructor
HMACFactory::__invoke() — Method in class HMACFactory

Create an object

AdapterFactory::__construct() — Method in class AdapterFactory
Constructor
AdapterFactory::__invoke() — Method in class AdapterFactory

Create an object (glue code for FactoryInterface compliance)

AccessToken::__construct() — Method in class AccessToken
Constructor
AuthHash::__construct() — Method in class AuthHash
Constructor
ChangeTracker::__construct() — Method in class ChangeTracker
Constructor
Comments::__construct() — Method in class Comments
Constructor
ExternalSession::__construct() — Method in class ExternalSession
Constructor
Feedback::__construct() — Method in class Feedback
Constructor
OaiResumption::__construct() — Method in class OaiResumption
Constructor
PrivateUser::__get() — Method in class PrivateUser
__get
Ratings::__construct() — Method in class Ratings
Constructor
Record::__construct() — Method in class Record
Constructor
Resource::__construct() — Method in class Resource
Constructor
ResourceTags::__construct() — Method in class ResourceTags
Constructor
RowGatewayFactory::__invoke() — Method in class RowGatewayFactory

Create an object

Search::__construct() — Method in class Search
Constructor
Session::__construct() — Method in class Session
Constructor
Shortlinks::__construct() — Method in class Shortlinks
Constructor
Tags::__construct() — Method in class Tags
Constructor
User::__construct() — Method in class User
Constructor
UserCard::__construct() — Method in class UserCard
Constructor
UserFactory::__invoke() — Method in class UserFactory

Create an object

UserList::__construct() — Method in class UserList
Constructor
UserListFactory::__invoke() — Method in class UserListFactory

Create an object

UserResource::__construct() — Method in class UserResource
Constructor
AccessToken::__construct() — Method in class AccessToken
Constructor
AuthHash::__construct() — Method in class AuthHash
Constructor
CaseSensitiveTagsFactory::__invoke() — Method in class CaseSensitiveTagsFactory

Create an object

ChangeTracker::__construct() — Method in class ChangeTracker
Constructor
Comments::__construct() — Method in class Comments
Constructor
ExternalSession::__construct() — Method in class ExternalSession
Constructor
Feedback::__construct() — Method in class Feedback
Constructor
Gateway::__construct() — Method in class Gateway
Constructor
GatewayFactory::__invoke() — Method in class GatewayFactory

Create an object

OaiResumption::__construct() — Method in class OaiResumption
Constructor
PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginManager::__construct() — Method in class PluginManager
Constructor
Ratings::__construct() — Method in class Ratings
Constructor
Record::__construct() — Method in class Record
Constructor
Resource::__construct() — Method in class Resource
Constructor
ResourceFactory::__invoke() — Method in class ResourceFactory

Create an object

ResourceTags::__construct() — Method in class ResourceTags
Constructor
Search::__construct() — Method in class Search
Constructor
Session::__construct() — Method in class Session
Constructor
Shortlinks::__construct() — Method in class Shortlinks
Constructor
Tags::__construct() — Method in class Tags
Constructor
User::__construct() — Method in class User
Constructor
UserCard::__construct() — Method in class UserCard
Constructor
UserFactory::__invoke() — Method in class UserFactory

Create an object

UserList::__construct() — Method in class UserList
Constructor
UserListFactory::__invoke() — Method in class UserListFactory

Create an object

UserResource::__construct() — Method in class UserResource
Constructor
OverdriveConnector::__construct() — Method in class OverdriveConnector
Constructor
OverdriveConnectorFactory::__invoke() — Method in class OverdriveConnectorFactory

Create an object

BrowZine::__construct() — Method in class BrowZine
Constructor
BrowZineFactory::__invoke() — Method in class BrowZineFactory

Create an object

Unpaywall::__construct() — Method in class Unpaywall
Constructor
UnpaywallFactory::__invoke() — Method in class UnpaywallFactory

Create an object

HttpDownloadException::__construct() — Method in class HttpDownloadException
Constructor
Export::__construct() — Method in class Export
Constructor
ExportFactory::__invoke() — Method in class ExportFactory

Create an object

FavoritesService::__construct() — Method in class FavoritesService
Constructor
FavoritesServiceFactory::__invoke() — Method in class FavoritesServiceFactory

Create service

Feed::__construct() — Method in class Feed
Constructor
Feed::_appendNamespaces() — Method in class Feed

Append feed namespaces

Form::__construct() — Method in class Form
Constructor
FormFactory::__invoke() — Method in class FormFactory

Create an object

Database::__construct() — Method in class Database
Constructor
DatabaseFactory::__invoke() — Method in class DatabaseFactory

Create an object

Email::__construct() — Method in class Email
Contructor
EmailFactory::__invoke() — Method in class EmailFactory

Create an object

PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginManager::__construct() — Method in class PluginManager
Constructor
AbstractConfig::__construct() — Method in class AbstractConfig
Constructor
AbstractConfigFactory::__invoke() — Method in class AbstractConfigFactory

Create an object

AbstractBase::__construct() — Method in class AbstractBase
Constructor
ConfigurationBasedFactory::__invoke() — Method in class ConfigurationBasedFactory

This constructs a hierarchy driver using VuFind's service setup.

AbstractBaseFactory::__invoke() — Method in class AbstractBaseFactory

Create an object

Solr::__construct() — Method in class Solr
Constructor.
SolrFactory::__invoke() — Method in class SolrFactory

Create an object

JSTree::__construct() — Method in class JSTree
Constructor
JSTreeFactory::__invoke() — Method in class JSTreeFactory

Create an object

CachingDownloader::__construct() — Method in class CachingDownloader
Constructor
CachingDownloaderFactory::__invoke() — Method in class CachingDownloaderFactory

Create an object

RemoteAddressFactory::__invoke() — Method in class RemoteAddressFactory

Create an object

LocaleDetectorFactory::__invoke() — Method in class LocaleDetectorFactory

A factory that creates delegates of a given service

LocaleSettings::__construct() — Method in class LocaleSettings
Constructor
Sorter::__construct() — Method in class Sorter
Constructor
SorterFactory::__invoke() — Method in class SorterFactory

Create an object

TranslatableString::__construct() — Method in class TranslatableString
Constructor
TranslatableString::__toString() — Method in class TranslatableString

Return the original string by default

ExtendedIni::__construct() — Method in class ExtendedIni
Constructor
ExtendedIniFactory::__invoke() — Method in class ExtendedIniFactory

Create an object

TranslatorFactory::__invoke() — Method in class TranslatorFactory

A factory that creates delegates of a given service

Connection::__construct() — Method in class Connection
Constructor
Connection::__call() — Method in class Connection

Default method -- pass along calls to the driver if available; return false otherwise. This allows custom functions to be implemented in the driver without constant modification to the connection class.

ConnectionFactory::__invoke() — Method in class ConnectionFactory

Create an object

Aleph::__construct() — Method in class Aleph
Constructor
AlephFactory::__invoke() — Method in class AlephFactory

Create an object

AlephTranslator::__construct() — Method in class AlephTranslator
Constructor
Alma::__construct() — Method in class Alma
Constructor
AlmaFactory::__invoke() — Method in class AlmaFactory

Create an object

DAIA::__construct() — Method in class DAIA
Constructor
Demo::__construct() — Method in class Demo
Constructor
DemoFactory::__invoke() — Method in class DemoFactory

Create an object

DriverWithDateConverterFactory::__invoke() — Method in class DriverWithDateConverterFactory

Create an object

Evergreen::__construct() — Method in class Evergreen
Constructor
Folio::__construct() — Method in class Folio
Constructor
FolioFactory::__invoke() — Method in class FolioFactory

Create an object

GeniePlus::__construct() — Method in class GeniePlus
Constructor
GeniePlusFactory::__invoke() — Method in class GeniePlusFactory

Create an object

Horizon::__construct() — Method in class Horizon
Constructor
Koha::__construct() — Method in class Koha
Constructor
KohaILSDI::__construct() — Method in class KohaILSDI
Constructor
KohaRest::__construct() — Method in class KohaRest
Constructor
KohaRestFactory::__invoke() — Method in class KohaRestFactory

Create an object

MultiBackend::__construct() — Method in class MultiBackend
Constructor
MultiBackend::__call() — Method in class MultiBackend

Default method -- pass along calls to the driver if a source can be determined and a driver is available. Throws ILSException otherwise.

MultiBackendFactory::__invoke() — Method in class MultiBackendFactory

Create an object

NoILS::__construct() — Method in class NoILS
Constructor
NoILSFactory::__invoke() — Method in class NoILSFactory

Create an object

PAIA::__construct() — Method in class PAIA
Constructor
PAIAFactory::__invoke() — Method in class PAIAFactory

Create an object

PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginManager::__construct() — Method in class PluginManager
Constructor
SierraRest::__construct() — Method in class SierraRest
Constructor
SierraRestFactory::__invoke() — Method in class SierraRestFactory

Create an object

Symphony::__construct() — Method in class Symphony
Constructor
SymphonyFactory::__invoke() — Method in class SymphonyFactory

Create an object

Unicorn::__construct() — Method in class Unicorn
Constructor
UnicornFactory::__invoke() — Method in class UnicornFactory

Create an object

Voyager::__construct() — Method in class Voyager
Constructor
VoyagerRestful::__construct() — Method in class VoyagerRestful
Constructor
VoyagerRestfulFactory::__invoke() — Method in class VoyagerRestfulFactory

Create an object

XCNCIP2::__construct() — Method in class XCNCIP2
Constructor
XCNCIP2Factory::__invoke() — Method in class XCNCIP2Factory

Create an object

HoldSettings::__construct() — Method in class HoldSettings
Constructor
HoldSettingsFactory::__invoke() — Method in class HoldSettingsFactory

Create an object

Holds::__construct() — Method in class Holds
Constructor
LogicFactory::__invoke() — Method in class LogicFactory

Create an object

TitleHolds::__construct() — Method in class TitleHolds
Constructor
Logger::__construct() — Method in class Logger
Constructor
LoggerFactory::__invoke() — Method in class LoggerFactory

Create an object

Office365::__construct() — Method in class Office365
Constructor
Post::__construct() — Method in class Post
Constructor
Slack::__construct() — Method in class Slack
Constructor
Factory::__invoke() — Method in class Factory

Create an object

Mailer::__construct() — Method in class Mailer
Constructor
PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginManager::__construct() — Method in class PluginManager
Constructor
UserIpReader::__construct() — Method in class UserIpReader
Constructor
UserIpReaderFactory::__invoke() — Method in class UserIpReaderFactory

Create an object

DefaultSpellingNormalizer::__invoke() — Method in class DefaultSpellingNormalizer

Apply normalization to a string.

Server::__construct() — Method in class Server
Constructor
ServerFactory::__invoke() — Method in class ServerFactory

Create an object

Auth::__construct() — Method in class Auth
Constructor
ClientEntity::__construct() — Method in class ClientEntity
Constructor
ScopeEntity::__construct() — Method in class ScopeEntity
Constructor
UserEntity::__construct() — Method in class UserEntity
Constructor
AbstractTokenRepository::__construct() — Method in class AbstractTokenRepository
Constructor
AccessTokenRepository::__construct() — Method in class AccessTokenRepository
Constructor
AuthCodeRepository::__construct() — Method in class AuthCodeRepository
Constructor
ClientRepository::__construct() — Method in class ClientRepository
Constructor
IdentityRepository::__construct() — Method in class IdentityRepository
Constructor
IdentityRepositoryFactory::__invoke() — Method in class IdentityRepositoryFactory

Create an object

RefreshTokenRepository::__construct() — Method in class RefreshTokenRepository
Constructor
RepositoryWithAccessTokenTableFactory::__invoke() — Method in class RepositoryWithAccessTokenTableFactory

Create an object

RepositoryWithOAuth2ConfigFactory::__invoke() — Method in class RepositoryWithOAuth2ConfigFactory

Create an object

ScopeRepository::__construct() — Method in class ScopeRepository
Constructor
Loader::__construct() — Method in class Loader
Constructor
LoaderFactory::__invoke() — Method in class LoaderFactory

Create an object

AbstractFacets::__construct() — Method in class AbstractFacets
Constructor
AbstractSummonRecommend::__construct() — Method in class AbstractSummonRecommend
Constructor
AuthorFacets::__construct() — Method in class AuthorFacets
Constructor
AuthorInfo::__construct() — Method in class AuthorInfo
Constructor
AuthorInfoFactory::__invoke() — Method in class AuthorInfoFactory

Create an object

AuthorityRecommend::__construct() — Method in class AuthorityRecommend
Constructor
CollectionSideFacetsFactory::__invoke() — Method in class CollectionSideFacetsFactory

Create an object

DPLATerms::__construct() — Method in class DPLATerms
Constructor
DPLATermsFactory::__invoke() — Method in class DPLATermsFactory

Create an object

EuropeanaResults::__construct() — Method in class EuropeanaResults
Constructor
EuropeanaResultsFactory::__invoke() — Method in class EuropeanaResultsFactory

Create an object

ExpandFacets::__construct() — Method in class ExpandFacets
Constructor
ExpandFacetsFactory::__invoke() — Method in class ExpandFacetsFactory

Create an object

FavoriteFacets::__construct() — Method in class FavoriteFacets
Constructor
FavoriteFacetsFactory::__invoke() — Method in class FavoriteFacetsFactory

Create an object

InjectConfigManagerFactory::__invoke() — Method in class InjectConfigManagerFactory

Create an object

InjectResultsManagerFactory::__invoke() — Method in class InjectResultsManagerFactory

Create an object

InjectSearchRunnerFactory::__invoke() — Method in class InjectSearchRunnerFactory

Create an object

MapSelection::__construct() — Method in class MapSelection
Constructor
MapSelectionFactory::__invoke() — Method in class MapSelectionFactory

Create an object

PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginManager::__construct() — Method in class PluginManager
Constructor
RandomRecommend::__construct() — Method in class RandomRecommend
Constructor
RandomRecommendFactory::__invoke() — Method in class RandomRecommendFactory

Create an object

RecommendLinks::__construct() — Method in class RecommendLinks
Constructor
SearchObject::__construct() — Method in class SearchObject
Constructor
SideFacets::__construct() — Method in class SideFacets
Constructor
SideFacetsFactory::__invoke() — Method in class SideFacetsFactory

Create an object

SummonBestBetsDeferred::__construct() — Method in class SummonBestBetsDeferred
Constructor
SummonDatabasesDeferred::__construct() — Method in class SummonDatabasesDeferred
Constructor
SummonResultsDeferred::__construct() — Method in class SummonResultsDeferred
Constructor
SwitchQuery::__construct() — Method in class SwitchQuery
Constructor
SwitchQueryFactory::__invoke() — Method in class SwitchQueryFactory

Create an object

WorldCatIdentities::__construct() — Method in class WorldCatIdentities
Constructor
WorldCatIdentitiesFactory::__invoke() — Method in class WorldCatIdentitiesFactory

Create an object

AbstractBase::__construct() — Method in class AbstractBase
Constructor
AbstractBaseFactory::__invoke() — Method in class AbstractBaseFactory

Create an object

DefaultRecord::__construct() — Method in class DefaultRecord
Constructor
IlsAwareDelegatorFactory::__invoke() — Method in class IlsAwareDelegatorFactory

Invokes this factory.

Missing::__construct() — Method in class Missing
Constructor
NameBasedConfigFactory::__invoke() — Method in class NameBasedConfigFactory

Create an object

PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginManager::__construct() — Method in class PluginManager
Constructor
PublicationDetails::__construct() — Method in class PublicationDetails
Constructor
PublicationDetails::__toString() — Method in class PublicationDetails

Represent object as a string

SolrAuthMarc::__construct() — Method in class SolrAuthMarc
Constructor
SolrDefault::__construct() — Method in class SolrDefault
Constructor
SolrDefaultFactory::__invoke() — Method in class SolrDefaultFactory

Create an object

SolrDefaultWithoutSearchServiceFactory::__invoke() — Method in class SolrDefaultWithoutSearchServiceFactory

Create an object

SolrMarcRemote::__construct() — Method in class SolrMarcRemote
Constructor
SolrOverdrive::__construct() — Method in class SolrOverdrive
Constructor
SolrOverdriveFactory::__invoke() — Method in class SolrOverdriveFactory

Create an object

SolrWeb::__construct() — Method in class SolrWeb
Constructor
SolrWebFactory::__invoke() — Method in class SolrWebFactory

Create an object

SummonFactory::__invoke() — Method in class SummonFactory

Create an object

AbstractContent::__construct() — Method in class AbstractContent
Constructor
AbstractContentFactory::__invoke() — Method in class AbstractContentFactory

Create an object

CollectionHierarchyTree::__construct() — Method in class CollectionHierarchyTree
Constructor
CollectionHierarchyTreeFactory::__invoke() — Method in class CollectionHierarchyTreeFactory

Create an object

CollectionList::__construct() — Method in class CollectionList
Constructor
CollectionListFactory::__invoke() — Method in class CollectionListFactory

Create an object

ComponentParts::__construct() — Method in class ComponentParts
Constructor
ComponentPartsFactory::__invoke() — Method in class ComponentPartsFactory

Create an object

Formats::__construct() — Method in class Formats
Constructor
HierarchyTree::__construct() — Method in class HierarchyTree
Constructor
HierarchyTreeFactory::__invoke() — Method in class HierarchyTreeFactory

Create an object

HoldingsILS::__construct() — Method in class HoldingsILS
Constructor
HoldingsILSFactory::__invoke() — Method in class HoldingsILSFactory

Create an object

HoldingsWorldCat::__construct() — Method in class HoldingsWorldCat
Constructor
HoldingsWorldCatFactory::__invoke() — Method in class HoldingsWorldCatFactory

Create an object

Map::__construct() — Method in class Map
Constructor
MapFactory::__invoke() — Method in class MapFactory

Create an object

PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginManager::__construct() — Method in class PluginManager
Constructor
Preview::__construct() — Method in class Preview
Constructor
PreviewFactory::__invoke() — Method in class PreviewFactory

Create an object

SimilarItemsCarousel::__construct() — Method in class SimilarItemsCarousel
Constructor
SimilarItemsCarouselFactory::__invoke() — Method in class SimilarItemsCarouselFactory

Create an object

StaffViewArray::__construct() — Method in class StaffViewArray
Constructor
StaffViewMARC::__construct() — Method in class StaffViewMARC
Constructor
StaffViewOverdrive::__construct() — Method in class StaffViewOverdrive
Constructor
TabManager::__construct() — Method in class TabManager
Constructor
TabManagerFactory::__invoke() — Method in class TabManagerFactory

Create an object

UserComments::__construct() — Method in class UserComments
Constructor
UserCommentsFactory::__invoke() — Method in class UserCommentsFactory

Create an object

Versions::__construct() — Method in class Versions
Constructor
VersionsFactory::__invoke() — Method in class VersionsFactory

Create an object

Cache::__construct() — Method in class Cache
Constructor
CacheFactory::__invoke() — Method in class CacheFactory

Create an object

Checklist::__construct() — Method in class Checklist
Constructor
AbstractFallbackLoader::__construct() — Method in class AbstractFallbackLoader
Constructor
AbstractFallbackLoaderFactory::__invoke() — Method in class AbstractFallbackLoaderFactory

Create an object

Solr::__construct() — Method in class Solr
Constructor
SolrFactory::__invoke() — Method in class SolrFactory

Create an object

Loader::__construct() — Method in class Loader
Constructor
LoaderFactory::__invoke() — Method in class LoaderFactory

Create an object

Router::__construct() — Method in class Router
Constructor
SourceAndIdList::__construct() — Method in class SourceAndIdList
Constructor
Bookplate::__construct() — Method in class Bookplate
Constructor
BookplateFactory::__invoke() — Method in class BookplateFactory

Create an object

PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginManager::__construct() — Method in class PluginManager
Constructor
Similar::__construct() — Method in class Similar
Constructor
SimilarFactory::__invoke() — Method in class SimilarFactory

Create an object

CsvReader::__construct() — Method in class CsvReader
Constructor
Connection::__construct() — Method in class Connection
Constructor
Connection::__call() — Method in class Connection

Default method -- pass along calls to the driver if available; return false otherwise. This allows custom functions to be implemented in the driver without constant modification to the connection class.

AbstractBase::__construct() — Method in class AbstractBase
Constructor
AbstractBaseFactory::__invoke() — Method in class AbstractBaseFactory

Create an object

Alma::__construct() — Method in class Alma
Constructor
AlmaFactory::__invoke() — Method in class AlmaFactory

Create an object

Demo::__construct() — Method in class Demo
Constructor
DriverWithHttpClientFactory::__invoke() — Method in class DriverWithHttpClientFactory

Create an object

Jop::__construct() — Method in class Jop
Constructor
JopFactory::__invoke() — Method in class JopFactory

Create an object

PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginManager::__construct() — Method in class PluginManager
Constructor
Redi::__construct() — Method in class Redi
Constructor
Sfx::__construct() — Method in class Sfx
Constructor
Threesixtylink::__construct() — Method in class Threesixtylink
Constructor
DynamicRoleProvider::__construct() — Method in class DynamicRoleProvider
Constructor
DynamicRoleProviderFactory::__invoke() — Method in class DynamicRoleProviderFactory

Create service

PermissionDeniedManager::__construct() — Method in class PermissionDeniedManager
Constructor
PermissionDeniedManagerFactory::__invoke() — Method in class PermissionDeniedManagerFactory

Create an object

PermissionManager::__construct() — Method in class PermissionManager
Constructor
PermissionManagerFactory::__invoke() — Method in class PermissionManagerFactory

Create an object

InjectAuthorizationServiceFactory::__invoke() — Method in class InjectAuthorizationServiceFactory

Create an object

InjectRequestFactory::__invoke() — Method in class InjectRequestFactory

Create an object

IpRange::__construct() — Method in class IpRange
Constructor
IpRangeFactory::__invoke() — Method in class IpRangeFactory

Create an object

IpRegEx::__construct() — Method in class IpRegEx
Constructor
IpRegExFactory::__invoke() — Method in class IpRegExFactory

Create an object

ServerParam::__construct() — Method in class ServerParam
Constructor
Shibboleth::__construct() — Method in class Shibboleth
Constructor
ShibbolethFactory::__invoke() — Method in class ShibbolethFactory

Create an object

User::__construct() — Method in class User
Constructor
Username::__construct() — Method in class Username
Constructor
AbstractBase::__construct() — Method in class AbstractBase
Constructor
Clickatell::__construct() — Method in class Clickatell
Constructor
Factory::__invoke() — Method in class Factory

Create service

Mailer::__construct() — Method in class Mailer
Constructor
BackendManager::__construct() — Method in class BackendManager
Constructor.
BackendManagerFactory::__invoke() — Method in class BackendManagerFactory

Create an object

FacetCache::__construct() — Method in class FacetCache
Constructor
FacetCacheFactory::__invoke() — Method in class FacetCacheFactory

Create an object

HideFacetValueListener::__construct() — Method in class HideFacetValueListener
Constructor.
Options::__construct() — Method in class Options
Constructor
Params::__construct() — Method in class Params
Constructor
Params::__clone() — Method in class Params

Copy constructor

Results::__construct() — Method in class Results
Constructor
Results::__clone() — Method in class Results

Copy constructor

Options::__construct() — Method in class Options
Constructor
Params::__construct() — Method in class Params
Constructor
ParamsFactory::__invoke() — Method in class ParamsFactory

Create an object

Options::__construct() — Method in class Options
Constructor
Options::__construct() — Method in class Options
Constructor
Options::__construct() — Method in class Options
Constructor
OptionsFactory::__invoke() — Method in class OptionsFactory

Create an object

Params::__construct() — Method in class Params
Constructor
Options::__construct() — Method in class Options
Constructor
AbstractBackendFactory::__construct() — Method in class AbstractBackendFactory
Constructor
AbstractSolrBackendFactory::__construct() — Method in class AbstractSolrBackendFactory
Constructor
AbstractSolrBackendFactory::__invoke() — Method in class AbstractSolrBackendFactory

Create service

BlenderBackendFactory::__invoke() — Method in class BlenderBackendFactory

Create service

BrowZineBackendFactory::__invoke() — Method in class BrowZineBackendFactory

Create service

EITBackendFactory::__invoke() — Method in class EITBackendFactory

Create service

EdsBackendFactory::__invoke() — Method in class EdsBackendFactory

Create service

LibGuidesBackendFactory::__invoke() — Method in class LibGuidesBackendFactory

Create service

Pazpar2BackendFactory::__invoke() — Method in class Pazpar2BackendFactory

Create service

PrimoBackendFactory::__invoke() — Method in class PrimoBackendFactory

Create service

Search2BackendFactory::__construct() — Method in class Search2BackendFactory
Constructor
SolrAuthBackendFactory::__construct() — Method in class SolrAuthBackendFactory
Constructor
SolrDefaultBackendFactory::__construct() — Method in class SolrDefaultBackendFactory
Constructor
SolrReservesBackendFactory::__construct() — Method in class SolrReservesBackendFactory
Constructor
SolrWebBackendFactory::__construct() — Method in class SolrWebBackendFactory
Constructor
SummonBackendFactory::__invoke() — Method in class SummonBackendFactory

Create service

WorldCatBackendFactory::__invoke() — Method in class WorldCatBackendFactory

Create service

Options::__construct() — Method in class Options
Constructor
Results::__construct() — Method in class Results
Constructor
ResultsFactory::__invoke() — Method in class ResultsFactory

Create an object

History::__construct() — Method in class History

History constructor

HistoryFactory::__invoke() — Method in class HistoryFactory

Create an object

Options::__construct() — Method in class Options
Constructor
Memory::__construct() — Method in class Memory
Constructor
MemoryFactory::__invoke() — Method in class MemoryFactory

Create an object

Minified::__construct() — Method in class Minified

Constructor. Building minified object from the searchObject passed in. Needs to be kept up-to-date with the deminify() function on searchObject.

NormalizedSearch::__construct() — Method in class NormalizedSearch
Constructor
OptionsFactory::__invoke() — Method in class OptionsFactory

Create an object

PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginFactory::__invoke() — Method in class PluginFactory

Create a service for the specified name.

PluginManager::__construct() — Method in class PluginManager
Constructor
ParamsFactory::__invoke() — Method in class ParamsFactory

Create an object

PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginFactory::__invoke() — Method in class PluginFactory

Create a service for the specified name.

PluginManager::__construct() — Method in class PluginManager
Constructor
Options::__construct() — Method in class Options
Constructor
InjectOnCampusListener::__construct() — Method in class InjectOnCampusListener
Constructor.
Options::__construct() — Method in class Options
Constructor
PrimoPermissionHandler::__construct() — Method in class PrimoPermissionHandler
Constructor.
RecommendListener::__construct() — Method in class RecommendListener
Constructor.
PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginFactory::__invoke() — Method in class PluginFactory

Create a service for the specified name.

PluginManager::__construct() — Method in class PluginManager
Constructor
ResultsFactory::__invoke() — Method in class ResultsFactory

Create an object

Options::__construct() — Method in class Options
Constructor
ResultsFactory::__invoke() — Method in class ResultsFactory

Create an object

SearchNormalizer::__construct() — Method in class SearchNormalizer
Constructor
SearchNormalizerFactory::__invoke() — Method in class SearchNormalizerFactory

Create an object

SearchRunner::__construct() — Method in class SearchRunner
Constructor
SearchRunnerFactory::__invoke() — Method in class SearchRunnerFactory

Create an object

SearchTabsHelper::__construct() — Method in class SearchTabsHelper
Constructor
SearchTabsHelperFactory::__invoke() — Method in class SearchTabsHelperFactory

Create an object

Options::__construct() — Method in class Options
Constructor
Options::__construct() — Method in class Options
Constructor
Options::__construct() — Method in class Options
Constructor
Results::__construct() — Method in class Results
Constructor
Options::__construct() — Method in class Options
Constructor
Options::__construct() — Method in class Options
Constructor
Options::__construct() — Method in class Options
Constructor
AbstractErrorListener::__construct() — Method in class AbstractErrorListener
Constructor.
CustomFilterListener::__construct() — Method in class CustomFilterListener
Constructor.
DeduplicationListener::__construct() — Method in class DeduplicationListener
Constructor.
DefaultParametersListener::__construct() — Method in class DefaultParametersListener
Constructor.
FilterFieldConversionListener::__construct() — Method in class FilterFieldConversionListener
Constructor.
HierarchicalFacetHelperFactory::__invoke() — Method in class HierarchicalFacetHelperFactory

Create an object

HierarchicalFacetListener::__construct() — Method in class HierarchicalFacetListener
Constructor.
InjectConditionalFilterListener::__construct() — Method in class InjectConditionalFilterListener
Constructor.
InjectHighlightingListener::__construct() — Method in class InjectHighlightingListener
Constructor.
InjectSpellingListener::__construct() — Method in class InjectSpellingListener
Constructor.
MultiIndexListener::__construct() — Method in class MultiIndexListener
Constructor.
Options::__construct() — Method in class Options
Constructor
Params::__construct() — Method in class Params
Constructor
ParamsFactory::__invoke() — Method in class ParamsFactory

Create an object

ResultsFactory::__invoke() — Method in class ResultsFactory

Create an object

SpellingProcessor::__construct() — Method in class SpellingProcessor
Constructor
Options::__construct() — Method in class Options
Constructor
Params::__construct() — Method in class Params
Constructor
Options::__construct() — Method in class Options
Constructor
Results::__construct() — Method in class Results
Constructor
ResultsFactory::__invoke() — Method in class ResultsFactory

Create an object

UrlQueryHelper::__construct() — Method in class UrlQueryHelper
Constructor
UrlQueryHelper::__toString() — Method in class UrlQueryHelper

Magic method: behavior when this object is treated as a string.

Options::__construct() — Method in class Options
Constructor
CspHeaderGenerator::__construct() — Method in class CspHeaderGenerator

CspHeaderGenerator constructor.

CspHeaderGeneratorFactory::__invoke() — Method in class CspHeaderGeneratorFactory

Create an object

AbstractPluginFactory::__invoke() — Method in class AbstractPluginFactory

Create a service for the specified name.

AbstractPluginManager::__construct() — Method in class AbstractPluginManager
Constructor
AbstractPluginManagerFactory::__invoke() — Method in class AbstractPluginManagerFactory

Create an object

ServiceInitializer::__invoke() — Method in class ServiceInitializer

Given an instance and a Service Manager, initialize the instance.

CurrencyFormatter::__construct() — Method in class CurrencyFormatter
Constructor
CurrencyFormatterFactory::__invoke() — Method in class CurrencyFormatterFactory

Create an object

DateConverterFactory::__invoke() — Method in class DateConverterFactory

Create an object

HttpServiceFactory::__invoke() — Method in class HttpServiceFactory

Create an object

MarkdownFactory::__invoke() — Method in class MarkdownFactory

Create an object

ProxyConfigFactory::__invoke() — Method in class ProxyConfigFactory

Create an object

ReCaptchaFactory::__invoke() — Method in class ReCaptchaFactory

Create an object

SearchServiceFactory::__invoke() — Method in class SearchServiceFactory

Create an object

ServiceWithConfigIniFactory::__invoke() — Method in class ServiceWithConfigIniFactory

Create an object

AbstractBase::__construct() — Method in class AbstractBase
Constructor
AbstractBaseFactory::__invoke() — Method in class AbstractBaseFactory

Create an object

File::__construct() — Method in class File
Constructor
ManagerFactory::__invoke() — Method in class ManagerFactory

Create an object

Memcache::__construct() — Method in class Memcache
Constructor
PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginManager::__construct() — Method in class PluginManager
Constructor
Redis::__construct() — Method in class Redis
Constructor
RedisFactory::__invoke() — Method in class RedisFactory

Create an object

SecureDelegator::__construct() — Method in class SecureDelegator

SecureDelegator constructor.

SecureDelegator::__call() — Method in class SecureDelegator

Pass calls to non-existing methods to the wrapped Handler

SecureDelegatorFactory::__invoke() — Method in class SecureDelegatorFactory

Invokes this factory.

Generator::__construct() — Method in class Generator
Constructor
GeneratorFactory::__invoke() — Method in class GeneratorFactory

Create an object

PluginFactory::__construct() — Method in class PluginFactory
Constructor
PluginManager::__construct() — Method in class PluginManager
Constructor
ContentPages::__construct() — Method in class ContentPages
Constructor
ContentPagesFactory::__invoke() — Method in class ContentPagesFactory

Create an object

Index::__construct() — Method in class Index
Constructor
IndexFactory::__invoke() — Method in class IndexFactory

Create an object

AbstractIdFetcher::__construct() — Method in class AbstractIdFetcher
Constructor.
Sitemap::__construct() — Method in class Sitemap
Constructor
SitemapIndex::__construct() — Method in class SitemapIndex
Constructor
Writer::__construct() — Method in class Writer
Constructor
WriterFactory::__invoke() — Method in class WriterFactory

Create an object

Tags::__construct() — Method in class Tags
Constructor
TagsFactory::__invoke() — Method in class TagsFactory

Create an object

VuFindHighlighter::__construct() — Method in class VuFindHighlighter
Constructor
Database::__construct() — Method in class Database
Constructor
DatabaseFactory::__invoke() — Method in class DatabaseFactory

Create an object

ServiceFactory::__invoke() — Method in class ServiceFactory

Create an object

SessionCsrfFactory::__invoke() — Method in class SessionCsrfFactory

Create an object

AbstractLayoutClass::__construct() — Method in class AbstractLayoutClass
Constructor
AbstractLayoutClass::__invoke() — Method in class AbstractLayoutClass

Helper to allow easily configurable page layout -- given a broad class name, return appropriate CSS classes to lay out the page according to the current configuration file settings.

CopyToClipboardButton::__invoke() — Method in class CopyToClipboardButton

This helper creates button for copying content of an element into clipboard

Highlight::__construct() — Method in class Highlight
Constructor
LayoutClass::__invoke() — Method in class LayoutClass

Helper to allow easily configurable page layout -- given a broad class name, return appropriate CSS classes to lay out the page according to the current configuration file settings.

LayoutClassFactory::__invoke() — Method in class LayoutClassFactory

Create an object

AbstractJsStrings::__construct() — Method in class AbstractJsStrings
Constructor
AccountCapabilities::__construct() — Method in class AccountCapabilities
Constructor
AccountCapabilities::__invoke() — Method in class AccountCapabilities

Get the capabilities helper.

AccountCapabilitiesFactory::__invoke() — Method in class AccountCapabilitiesFactory

Create an object

AddEllipsis::__invoke() — Method in class AddEllipsis

Adds "..." to the beginning and/or end of a highlighted phrase when incomplete text is detected.

AddThis::__construct() — Method in class AddThis
Constructor
AddThis::__invoke() — Method in class AddThis

Returns AddThis API key (if AddThis is active) or false if not.

AddThisFactory::__invoke() — Method in class AddThisFactory

Create an object

AlphaBrowse::__construct() — Method in class AlphaBrowse
Constructor
AlphaBrowseFactory::__invoke() — Method in class AlphaBrowseFactory

Create an object

Auth::__construct() — Method in class Auth
Constructor
AuthFactory::__invoke() — Method in class AuthFactory

Create an object

Captcha::__construct() — Method in class Captcha
Constructor
Captcha::__invoke() — Method in class Captcha

Return this object

CaptchaFactory::__invoke() — Method in class CaptchaFactory

Create an object

Cart::__construct() — Method in class Cart
Constructor
Cart::__invoke() — Method in class Cart

Get the Cart object.

CartFactory::__invoke() — Method in class CartFactory

Create an object

Citation::__construct() — Method in class Citation
Constructor
Citation::__invoke() — Method in class Citation

Store a record driver object and return this object so that the appropriate template can be rendered.

CitationFactory::__invoke() — Method in class CitationFactory

Create an object

Component::__invoke() — Method in class Component

Expand path and render template

Config::__construct() — Method in class Config

Config constructor.

ConfigFactory::__invoke() — Method in class ConfigFactory

Create an object

Content::__construct() — Method in class Content
Constructor
ContentBlock::__invoke() — Method in class ContentBlock

Render the output of a ContentBlock plugin.

ContentFactory::__invoke() — Method in class ContentFactory

Create an object

ContentLoader::__construct() — Method in class ContentLoader
Constructor
ContentLoader::__invoke() — Method in class ContentLoader

Do the actual work of loading the notes.

ContentLoaderFactory::__invoke() — Method in class ContentLoaderFactory

Create an object

Context::__invoke() — Method in class Context

Grab the helper object so we can call methods on it.

CookieConsent::__construct() — Method in class CookieConsent
Constructor
CookieConsent::__invoke() — Method in class CookieConsent

Return this object

CookieConsentFactory::__invoke() — Method in class CookieConsentFactory

Create an object

Csp::__construct() — Method in class Csp
Constructor
CspFactory::__invoke() — Method in class CspFactory

Create an object

CspNonce::__construct() — Method in class CspNonce
Constructor
CspNonce::__invoke() — Method in class CspNonce

Return the current nonce

CspNonceFactory::__invoke() — Method in class CspNonceFactory

Create an object

CurrentPath::__invoke() — Method in class CurrentPath

Get the path of the current URL.

DateTime::__construct() — Method in class DateTime
Constructor
DateTime::__call() — Method in class DateTime

By default, proxy method calls to the converter object.

DateTimeFactory::__invoke() — Method in class DateTimeFactory

Create an object

DisplayLanguageOption::__construct() — Method in class DisplayLanguageOption
Constructor
DisplayLanguageOption::__invoke() — Method in class DisplayLanguageOption

Translate a string

DisplayLanguageOptionFactory::__invoke() — Method in class DisplayLanguageOptionFactory

Create an object

Doi::__construct() — Method in class Doi
Constructor
Doi::__invoke() — Method in class Doi

Set up context for helper

DoiFactory::__invoke() — Method in class DoiFactory

Create an object

Export::__construct() — Method in class Export
Constructor
Export::__invoke() — Method in class Export

Get the Export object.

ExportFactory::__invoke() — Method in class ExportFactory

Create an object

Feedback::__construct() — Method in class Feedback
Constructor
FeedbackFactory::__invoke() — Method in class FeedbackFactory

Create an object

Flashmessages::__construct() — Method in class Flashmessages
Constructor
Flashmessages::__invoke() — Method in class Flashmessages

Generate flash message

's with appropriate classes based on message type.

FlashmessagesFactory::__invoke() — Method in class FlashmessagesFactory

Create an object

GeoCoords::__construct() — Method in class GeoCoords
Constructor
GeoCoordsFactory::__invoke() — Method in class GeoCoordsFactory

Create an object

GoogleAnalytics::__construct() — Method in class GoogleAnalytics
Constructor
GoogleAnalytics::__invoke() — Method in class GoogleAnalytics

Returns GA code (if active) or empty string if not.

GoogleAnalyticsFactory::__invoke() — Method in class GoogleAnalyticsFactory

Create an object

GoogleTagManager::__construct() — Method in class GoogleTagManager
Constructor
GoogleTagManagerFactory::__invoke() — Method in class GoogleTagManagerFactory

Create an object

HeadTitleFactory::__invoke() — Method in class HeadTitleFactory

Create an object

HelpText::__construct() — Method in class HelpText
Constructor
HelpTextFactory::__invoke() — Method in class HelpTextFactory

Create an object

Highlight::__invoke() — Method in class Highlight

Adds a span tag with class "highlight" around a specific phrase for highlighting

HistoryLabel::__construct() — Method in class HistoryLabel
Constructor
HistoryLabel::__invoke() — Method in class HistoryLabel

Return a label for the specified class (if configured).

HistoryLabelFactory::__invoke() — Method in class HistoryLabelFactory

Create an object

Holdings::__construct() — Method in class Holdings
Constructor
HoldingsFactory::__invoke() — Method in class HoldingsFactory

Create an object

Icon::__construct() — Method in class Icon
Constructor
Icon::__invoke() — Method in class Icon

Returns inline HTML for icon

IconFactory::__invoke() — Method in class IconFactory

Create an object

Ils::__construct() — Method in class Ils
Constructor
Ils::__invoke() — Method in class Ils

Get the ILS connection object.

IlsFactory::__invoke() — Method in class IlsFactory

Create an object

JsIcons::__construct() — Method in class JsIcons
Constructor
JsIconsFactory::__invoke() — Method in class JsIconsFactory

Create an object

JsTranslations::__construct() — Method in class JsTranslations
Constructor
JsTranslationsFactory::__invoke() — Method in class JsTranslationsFactory

Create an object

KeepAlive::__construct() — Method in class KeepAlive
Constructor
KeepAlive::__invoke() — Method in class KeepAlive

Returns the keep-alive interval.

KeepAliveFactory::__invoke() — Method in class KeepAliveFactory

Create an object

Linkify::__construct() — Method in class Linkify
Constructor
Linkify::__invoke() — Method in class Linkify

Replace urls and emails by html tags

LinkifyFactory::__invoke() — Method in class LinkifyFactory

Create an object

LocalizedNumber::__invoke() — Method in class LocalizedNumber

Localize number

MakeLink::__invoke() — Method in class MakeLink

Render an HTML link

MakeTag::__invoke() — Method in class MakeTag

Render an HTML tag

Markdown::__construct() — Method in class Markdown

Markdown constructor.

Markdown::__invoke() — Method in class Markdown

Converts markdown to html

MarkdownFactory::__invoke() — Method in class MarkdownFactory

Create an object

Matomo::__construct() — Method in class Matomo
Constructor
Matomo::__invoke() — Method in class Matomo

Returns Matomo code (if active) or empty string if not.

MatomoFactory::__invoke() — Method in class MatomoFactory

Create an object

Metadata::__construct() — Method in class Metadata
Constructor
MetadataFactory::__invoke() — Method in class MetadataFactory

Create an object

OpenUrl::__construct() — Method in class OpenUrl
Constructor
OpenUrl::__invoke() — Method in class OpenUrl

Set up context for helper

OpenUrlFactory::__invoke() — Method in class OpenUrlFactory

Create an object

Overdrive::__construct() — Method in class Overdrive
Constructor
OverdriveFactory::__invoke() — Method in class OverdriveFactory

Create an object

Permission::__construct() — Method in class Permission
Constructor
PermissionFactory::__invoke() — Method in class PermissionFactory

Create an object

Piwik::__construct() — Method in class Piwik
Constructor
Piwik::__invoke() — Method in class Piwik

Returns Piwik code (if active) or empty string if not.

PiwikFactory::__invoke() — Method in class PiwikFactory

Create an object

Printms::__invoke() — Method in class Printms

Prints a human readable format from a number of milliseconds

ProxyUrl::__construct() — Method in class ProxyUrl
Constructor
ProxyUrl::__invoke() — Method in class ProxyUrl

Apply proxy prefix to URL (if configured).

ProxyUrlFactory::__invoke() — Method in class ProxyUrlFactory

Create an object

Recommend::__invoke() — Method in class Recommend

Render the output of a recommendation module.

Record::__construct() — Method in class Record
Constructor
Record::__invoke() — Method in class Record

Store a record driver object and return this object so that the appropriate template can be rendered.

RecordDataFormatter::__invoke() — Method in class RecordDataFormatter

Store a record driver object and return this object so that the appropriate data can be rendered.

RecordDataFormatterFactory::__invoke() — Method in class RecordDataFormatterFactory

Create an object

SpecBuilder::__construct() — Method in class SpecBuilder
Constructor
RecordFactory::__invoke() — Method in class RecordFactory

Create an object

RecordLinker::__construct() — Method in class RecordLinker
Constructor
RecordLinkerFactory::__invoke() — Method in class RecordLinkerFactory

Create an object

Relais::__construct() — Method in class Relais
Constructor.
RelaisFactory::__invoke() — Method in class RelaisFactory

Create an object

Related::__construct() — Method in class Related
Constructor
RelatedFactory::__invoke() — Method in class RelatedFactory

Create an object

RenderArray::__invoke() — Method in class RenderArray

Render a portion of an array.

ResultFeed::__invoke() — Method in class ResultFeed

Represent the current search results as a feed.

ResultFeedFactory::__invoke() — Method in class ResultFeedFactory

Create an object

SafeMoneyFormat::__construct() — Method in class SafeMoneyFormat
Constructor
SafeMoneyFormat::__invoke() — Method in class SafeMoneyFormat

Convert currency to display format and escape the result

SafeMoneyFormatFactory::__invoke() — Method in class SafeMoneyFormatFactory

Create an object

SearchBox::__construct() — Method in class SearchBox
Constructor
SearchBoxFactory::__invoke() — Method in class SearchBoxFactory

Create an object

SearchMemory::__construct() — Method in class SearchMemory
Constructor
SearchMemoryFactory::__invoke() — Method in class SearchMemoryFactory

Create an object

SearchOptions::__construct() — Method in class SearchOptions
Constructor
SearchOptions::__invoke() — Method in class SearchOptions

Wrapper to the options plugin manager

SearchOptionsFactory::__invoke() — Method in class SearchOptionsFactory

Create an object

SearchParams::__construct() — Method in class SearchParams
Constructor
SearchParams::__invoke() — Method in class SearchParams

Wrapper to the options plugin manager

SearchParamsFactory::__invoke() — Method in class SearchParamsFactory

Create an object

SearchTabs::__construct() — Method in class SearchTabs
Constructor
SearchTabsFactory::__invoke() — Method in class SearchTabsFactory

Create an object

ServerUrlFactory::__invoke() — Method in class ServerUrlFactory

Create an object

ShortenUrl::__construct() — Method in class ShortenUrl
Constructor
ShortenUrl::__invoke() — Method in class ShortenUrl

Shorten a URL

ShortenUrlFactory::__invoke() — Method in class ShortenUrlFactory

Create an object

SortFacetList::__invoke() — Method in class SortFacetList

Turns facet information into an alphabetical list.

SortFacetListFactory::__invoke() — Method in class SortFacetListFactory

Create an object

Sorter::__invoke() — Method in class Sorter

Get sorter

SorterFactory::__invoke() — Method in class SorterFactory

Create an object

SyndeticsPlus::__construct() — Method in class SyndeticsPlus
Constructor
SyndeticsPlusFactory::__invoke() — Method in class SyndeticsPlusFactory

Create an object

SystemEmail::__construct() — Method in class SystemEmail
Constructor
SystemEmail::__invoke() — Method in class SystemEmail

System contact email helper.

SystemEmailFactory::__invoke() — Method in class SystemEmailFactory

Create an object

ThemeConfig::__construct() — Method in class ThemeConfig
Constructor
ThemeConfig::__invoke() — Method in class ThemeConfig

Returns config by path

ThemeConfigFactory::__invoke() — Method in class ThemeConfigFactory

Create an object

TransEsc::__invoke() — Method in class TransEsc

Translate and escape a string

TransEscAttr::__invoke() — Method in class TransEscAttr

Translate and escape a string for an HTML attribute

TransEscWithPrefix::__invoke() — Method in class TransEscWithPrefix

Translate and escape a location

Translate::__invoke() — Method in class Translate

Translate a string

TranslationEmpty::__invoke() — Method in class TranslationEmpty

Check if a translation is empty

Truncate::__invoke() — Method in class Truncate

Truncate a string

Url::__construct() — Method in class Url
Constructor
Url::__invoke() — Method in class Url

Generates a url given the name of a route.

UrlFactory::__invoke() — Method in class UrlFactory

Create an object

UserList::__construct() — Method in class UserList
Constructor
UserListFactory::__invoke() — Method in class UserListFactory

Create an object

UserTags::__construct() — Method in class UserTags
Constructor
UserTagsFactory::__invoke() — Method in class UserTagsFactory

Create an object

Importer::__construct() — Method in class Importer
Constructor